> For the complete documentation index, see [llms.txt](https://docs.idlayr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.idlayr.com/api-reference/management/models.md).

# Models

## The Workspace object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"Workspace":{"description":"A workspace — the top-level container for an account.","type":"object","unevaluatedProperties":false,"required":["workspace_id","name","data_residency","created_at"],"properties":{"workspace_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable workspace name.","type":"string"},"data_residency":{"description":"The region in which the workspace's data is stored.","type":"string","enum":["eu","us"]},"created_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The ProjectMode object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]}}}}
```

## The Project object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"Project":{"description":"A project — the unit a product is pointed at within a workspace.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at"],"properties":{"project_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The ProjectList object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ProjectList":{"description":"A page of projects.","type":"object","unevaluatedProperties":false,"required":["content","page"],"properties":{"content":{"description":"Projects in the current page.","type":"array","items":{"description":"A project.","$ref":"#/components/schemas/Project"}},"page":{"$ref":"#/components/schemas/page"}}},"Project":{"description":"A project — the unit a product is pointed at within a workspace.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at"],"properties":{"project_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}}}}}
```

## The ProjectCreate object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ProjectCreate":{"description":"The payload to create a project.","type":"object","unevaluatedProperties":false,"required":["name"],"properties":{"name":{"description":"Human-readable project name.","type":"string"},"mode":{"$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"}}},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}}}}}
```

## The ProjectWithCredentials object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ProjectWithCredentials":{"description":"A project together with the initial credentials provisioned for it.","type":"object","unevaluatedProperties":false,"required":["project_id","name","mode","created_at","updated_at","credentials"],"properties":{"project_id":{"description":"The unique ID of the project.","$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable project name.","type":"string"},"mode":{"description":"The project's mode.","$ref":"#/components/schemas/ProjectMode"},"description":{"description":"Optional free-text description of the project.","type":"string"},"rate_limit":{"description":"The per-project request rate limit, in requests per second.","type":"integer"},"configuration":{"description":"Per-product settings for the project.","$ref":"#/components/schemas/ProjectConfiguration"},"created_at":{"description":"When the project was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the project was last updated.","$ref":"#/components/schemas/ISODateTime"},"credentials":{"description":"The credentials provisioned with the project. Includes the one-time `client_secret`.","$ref":"#/components/schemas/CredentialWithSecret"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ProjectMode":{"description":"The project's mode:\n- `live`: production traffic, billed.\n- `sandbox`: test traffic against sandbox numbers.\n- `disabled`: the project is disabled and rejects product traffic.\n","type":"string","enum":["live","sandbox","disabled"]},"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"CredentialWithSecret":{"description":"A newly created credential, including the one-time `client_secret`.","type":"object","unevaluatedProperties":false,"required":["client_id","client_secret","scopes","created_at","updated_at"],"properties":{"client_id":{"$ref":"#/components/schemas/UUID"},"client_secret":{"description":"The OAuth2 client secret. Returned only on creation and never again.","type":"string"},"scopes":{"description":"The OAuth2 scopes granted to the credential.","type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/ISODateTime"},"updated_at":{"$ref":"#/components/schemas/ISODateTime"}}}}}}
```

## The ProjectConfiguration object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ProjectConfiguration":{"description":"Per-product settings for the project. Each block is optional and present only when the\ncorresponding product is configured.\n","type":"object","unevaluatedProperties":false,"properties":{"secure_sna":{"description":"Secure SNA callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"},"reverse_sms":{"description":"Reverse SMS settings.","$ref":"#/components/schemas/ReverseSmsConfig"},"discovery":{"description":"Discovery callback and redirect URLs.","$ref":"#/components/schemas/CallbackRedirectConfig"}}},"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}},"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}}}}}
```

## The CallbackRedirectConfig object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"CallbackRedirectConfig":{"description":"Callback and redirect URLs for a product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"redirect_url":{"description":"URL the device is redirected to at the end of the verification flow.","type":"string","format":"uri"}}}}}}
```

## The ReverseSmsConfig object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsConfig":{"description":"Settings for the Reverse SMS product.","type":"object","unevaluatedProperties":false,"properties":{"callback_url":{"description":"URL the platform calls with the terminal result of a check.","type":"string","format":"uri"},"custom_message_body":{"description":"Custom body for the SMS the device is asked to send.","type":"string"}}}}}}
```

## The Credential object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"Credential":{"description":"An OAuth2 client credential scoped to a project. `client_secret` is never returned by read operations.","type":"object","unevaluatedProperties":false,"required":["client_id","scopes","created_at","updated_at"],"properties":{"client_id":{"$ref":"#/components/schemas/UUID"},"scopes":{"description":"The OAuth2 scopes granted to the credential.","type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/ISODateTime"},"updated_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The CredentialWithSecret object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"CredentialWithSecret":{"description":"A newly created credential, including the one-time `client_secret`.","type":"object","unevaluatedProperties":false,"required":["client_id","client_secret","scopes","created_at","updated_at"],"properties":{"client_id":{"$ref":"#/components/schemas/UUID"},"client_secret":{"description":"The OAuth2 client secret. Returned only on creation and never again.","type":"string"},"scopes":{"description":"The OAuth2 scopes granted to the credential.","type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/ISODateTime"},"updated_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The CredentialList object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"CredentialList":{"description":"A page of credentials.","type":"object","unevaluatedProperties":false,"required":["content","page"],"properties":{"content":{"description":"Credentials in the current page.","type":"array","items":{"$ref":"#/components/schemas/Credential"}},"page":{"$ref":"#/components/schemas/page"}}},"Credential":{"description":"An OAuth2 client credential scoped to a project. `client_secret` is never returned by read operations.","type":"object","unevaluatedProperties":false,"required":["client_id","scopes","created_at","updated_at"],"properties":{"client_id":{"$ref":"#/components/schemas/UUID"},"scopes":{"description":"The OAuth2 scopes granted to the credential.","type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/ISODateTime"},"updated_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}}}}}
```

## The CredentialCreate object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"CredentialCreate":{"description":"The payload to create a credential.","type":"object","unevaluatedProperties":false,"required":["grant_type"],"properties":{"grant_type":{"description":"The OAuth2 grant type for the credential.","type":"string"}}}}}}
```

## The JsonPatch object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"JsonPatch":{"description":"A [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) document — an array of operations.","type":"array","items":{"type":"object","unevaluatedProperties":false,"required":["op","path"],"properties":{"op":{"description":"The operation to perform.","type":"string","enum":["add","remove","replace","move","copy","test"]},"path":{"description":"A JSON Pointer to the target location.","type":"string"},"value":{"description":"The value to apply. Required for `add`, `replace`, and `test`."},"from":{"description":"A JSON Pointer to the source location. Required for `move` and `copy`.","type":"string"}}}}}}}
```

## The Problem object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}}}}
```

## The UUID object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"}}}}
```

## The ISODateTime object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The RateLimitReached object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}}}}
```

## The page object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"components":{"schemas":{"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.idlayr.com/api-reference/management/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.