Provision an AI agent conversation in an organization

Prepares a conversation so the client can connect to it, giving the agent the credentials it acts with. Call this before opening a conversation; connecting to one that was never provisioned yields an agent whose tools all fail. The conversation itself is only recorded once the user sends a first message, so opening the agent and closing it again leaves nothing behind. Safe to call again to refresh an expiring session.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

conversationIdstringRequired

The unique ID of the agent conversation (its client-generated local id, or "default" for the default conversation)

Responses

204

The conversation is ready to be connected to.

No content

put/orgs/{organizationId}/agent/conversations/{conversationId}

PUT /v1/orgs/{organizationId}/agent/conversations/{conversationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

The conversation is ready to be connected to.

No content