Activities3

Agent Schedules6

Agents11

Alerts7

Annotation Queues10

Annotations2

API keys6

Audio3

Audit Logs1

Budgets6

Chat1

Chunking1

Completions1

Datasets11

Deployments2

Documentation1

Embeddings1

Evals9

Feedback4

File Systems10

Files6

Finder2

Guardrail Rules6

Human Review Sets5

Identities5

Images3

Knowledge Bases23

Logs10

Management keys6

MCP Gateway13

Memory Stores15

Model Catalog3

Model Sharing1

Models17

Moderations1

Notifiers5

Policies5

Projects5

Prompts7

Reporting1

Rerank1

Responses2

Router1

Routing Rules6

Skills5

Smart Routers5

Tools7

Traces9

Webhooks8

Workspace Security8

Workspace Settings2

Workspaces3

Deployments

Get config

Retrieve the deployment configuration

post/v2/deployments/get_config

Request body

keystring required

The deployment key to invoke

inputsobject

Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.

contextobject

Key-value pairs that match your data model and fields declared in your deployment routing configuration

file_idsstring[]

A list of file IDs that are associated with the deployment request.

metadataobject

Key-value pairs that you want to attach to the log generated by this request.

extra_paramsobject

Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration.

Example request

{
  "identity": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "jane.doe@example.com",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "documents": [
    {
      "text": "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
      "metadata": {
        "file_name": "refund_policy.pdf",
        "file_type": "application/pdf",
        "page_number": 1
      }
    },
    {
      "text": "Premium members receive free shipping on all orders over $50.",
      "metadata": {
        "file_name": "membership_benefits.md",
        "file_type": "text/markdown"
      }
    }
  ]
}

Response

Configurations Retrieved.

idstring required

A unique identifier for the response. Can be used to add metrics to the transaction.

providerstring required

The provider of the model

modelstring required

The model of the configuration

The type of the model. Current chat,completion and image are supported

versionstring required

The current version of the deployment

Example response

{
  "messages": [
    {
      "content": [
        {
          "image_url": {
            "url": "https://picsum.photos/id/1/200/300"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 22 of the 266 revisions of this API.111318

Aug 24, 2026addad33219df3See the full diff
- ▲
  removed subschema #9: exists from the // request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 20261586760a252f3See the full diff
- ○
  added subschema #9: exists to the // request property anyOf list
  request-property-any-of-added
- ○
  added subschema #9: exists to the //// request property anyOf list
  request-property-any-of-added
- ○
  added subschema #9: exists to the //// request property anyOf list
  request-property-any-of-added
This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 20264fdc24e562eb3See the full diff
- ▲
  removed subschema #9: exists from the // request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 20, 2026be3fe58ce3893See the full diff
- ○
  added subschema #9: exists to the // request property anyOf list
  request-property-any-of-added
- ○
  added subschema #9: exists to the //// request property anyOf list
  request-property-any-of-added
- ○
  added subschema #9: exists to the //// request property anyOf list
  request-property-any-of-added
This revision also has 175 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 20, 20269a63ca712c8b3See the full diff
- ▲
  removed subschema #9: exists from the // request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #9: exists from the //// request property anyOf list
  request-property-any-of-removed
Aug 2, 20266f132f005b2a2See the full diff
- ○
  removed the max enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the xhigh enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 97 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 20263128fb112d662See the full diff
- ●
  added the new max enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new xhigh enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 30, 2026d1ae9e3491f72See the full diff
- ○
  removed the max enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the xhigh enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 202681dd5e8c8ae52See the full diff
- ●
  added the new max enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new xhigh enum value to the / response property for the response status
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 2026c165184caee52See the full diff
- ○
  removed the max enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the xhigh enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 266 revisions, 77 have no diff computed.

Full history (22 revisions)