Deploy your assistant to production on Studio

Obtain API key and Project ID
Generate API keys via the developer configs in your project. Copy the Project ID from the same page.
API Endpoint
- For self-hosted:
<HOST>
ishttp://localhost:3000
Authentication
Include your API key in the Authorization header:Examples
First Turn
Subsequent Turn
Notice how we include both the previous messages and the state from the last response:API Specification
Request Schema
Message Types
Messages can be one of the following types:- System Message
- User Message
- Assistant Message
Response Schema
Important Notes
- Always pass the complete conversation history in the
messages
array - Always include the
state
from the previous response in your next request - The last message in the response’s
messages
array will be a user-facing assistant message (agenticResponseType: "external"
)
Rate Limiting
The API has rate limits per project. If exceeded, you’ll receive a 429 status code.Error Responses
- 400: Invalid request body or missing/invalid Authorization header
- 403: Invalid API key
- 404: Project or workflow not found
- 429: Rate limit exceeded