API essentials

Base URL

Use the API origin supplied for your deployment:

https://{your-deployment}

Endpoint paths include /v1; append the documented path once to this origin. For example, provisioning uses POST /v1/users. The documentation site has a separate origin and does not serve these API requests.

Account-dependent resources use the returned userId in their paths. Operation ids such as conversations.create and runs.start identify the same calls in logs and traces.

Fin documentation Built from the API contract · v1

Search all documentation