# Click API

> Run managed agents in your product. Choose your model, connect your tools, and stream results.

## Start here

- [Introduction](/reference/introduction.md)
- [Quick start](/reference/quick-start.md)
- [Canonical OpenAPI document](/reference/openapi.yaml)
- [Complete reference](/llms-full.txt)

## Example

- [Runnable SaaS backend](/reference/examples/saas.py)

## Operations

### Agents

- [GET /agents](/reference/operations/listAgents.md): List agent identities
- [POST /agents](/reference/operations/createAgent.md): Create an agent and its first immutable version
- [GET /agents/{agent_id}](/reference/operations/getAgent.md): Get an agent and its latest version
- [GET /agents/{agent_id}/versions](/reference/operations/listAgentVersions.md): List immutable versions newest first
- [POST /agents/{agent_id}/versions](/reference/operations/createAgentVersion.md): Create a new immutable version

### Model catalog

- [GET /models](/reference/operations/listModels.md): List supported model capabilities

### Sessions

- [GET /sessions](/reference/operations/listSessions.md): List sessions
- [POST /sessions](/reference/operations/createSession.md): Create a session from a specific agent version
- [GET /sessions/{session_id}](/reference/operations/getSession.md): Get session configuration
- [DELETE /sessions/{session_id}](/reference/operations/deleteSession.md): Stop work, release owned resources, and delete a session
- [GET /sessions/{session_id}/submissions](/reference/operations/listSubmissions.md): List submissions and their outcomes
- [POST /sessions/{session_id}/submissions](/reference/operations/submitInput.md): Submit input to a session
- [GET /sessions/{session_id}/submissions/{submission_id}](/reference/operations/getSubmission.md): Get a submission and its outcome
- [POST /sessions/{session_id}/submissions/{submission_id}/cancel](/reference/operations/cancelSubmission.md): Withdraw queued input
- [POST /sessions/{session_id}/cancel](/reference/operations/cancelSession.md): Cancel active work and queued inputs
- [GET /sessions/{session_id}/lifecycle](/reference/operations/getSessionLifecycle.md): Get the session's active, idle, standby or archived state
- [POST /sessions/{session_id}/archive](/reference/operations/archiveSession.md): Permanently stop a session and retain its history
- [POST /sessions/{session_id}/standby](/reference/operations/standbySession.md): Release an idle session's runtime resources
- [GET /sessions/{session_id}/entries](/reference/operations/listEntries.md): Read recorded conversation history
- [GET /sessions/{session_id}/tool-calls](/reference/operations/listToolCalls.md): List retained top-level and nested tool calls
- [GET /sessions/{session_id}/tool-calls/{call_id}](/reference/operations/getToolCall.md): Get a retained tool call and its recorded response
- [GET /sessions/{session_id}/state](/reference/operations/getState.md): Get the current conversation state
- [GET /sessions/{session_id}/events](/reference/operations/observeEvents.md): Observe live conversation events

### Files

- [GET /sessions/{session_id}/artifacts](/reference/operations/listSessionArtifacts.md): List published output artifacts
- [POST /files](/reference/operations/uploadFile.md): Store a downloadable file
- [GET /files/{file_id}](/reference/operations/downloadFile.md): Download original file bytes
- [DELETE /files/{file_id}](/reference/operations/deleteFile.md): Delete a stored file

### Webhooks

- [GET /webhooks](/reference/operations/listWebhooks.md): List webhook registrations
- [POST /webhooks](/reference/operations/createWebhook.md): Register a webhook endpoint
- [DELETE /webhooks/{webhook_id}](/reference/operations/deleteWebhook.md): Delete a registration and its delivery history
- [GET /webhooks/{webhook_id}/deliveries](/reference/operations/listWebhookDeliveries.md): Inspect webhook deliveries

### BYO credentials

- [GET /credentials](/reference/operations/listCredentials.md): List BYO credentials
- [POST /credentials](/reference/operations/createCredential.md): Store a BYO credential
- [PATCH /credentials/{credential_id}](/reference/operations/rotateCredential.md): Rotate provider API key
- [GET /credentials/{credential_id}](/reference/operations/getCredential.md): Get credential metadata
- [DELETE /credentials/{credential_id}](/reference/operations/deleteCredential.md): Delete a credential

### Tool connections

- [GET /connections](/reference/operations/listConnections.md): List tool connections
- [POST /connections](/reference/operations/createConnection.md): Create a tool connection
- [PATCH /connections/{connection_id}](/reference/operations/rotateConnection.md): Rotate connection authentication
- [GET /connections/{connection_id}](/reference/operations/getConnection.md): Get connection metadata
- [DELETE /connections/{connection_id}](/reference/operations/deleteConnection.md): Delete a tool connection

### Platform API keys

- [GET /api-keys](/reference/operations/listApiKeys.md): List platform API key metadata
- [POST /api-keys](/reference/operations/createApiKey.md): Create a platform API key for the current tenant
- [DELETE /api-keys/{key_id}](/reference/operations/deleteApiKey.md): Revoke a platform API key

### Usage

- [GET /usage](/reference/operations/getUsage.md): Get the current tenant's usage and effective plan limits

### Billing

- [GET /billing/status](/reference/operations/getBillingStatus.md): Check card verification
- [POST /billing/verification](/reference/operations/verifyCard.md): Open card verification
- [POST /billing/checkout](/reference/operations/createBillingCheckout.md): Open Pro subscription checkout
- [POST /billing/portal](/reference/operations/createBillingPortal.md): Open pricing or billing management


## Schemas

- [BillingRedirect](/reference/schemas/BillingRedirect.md)
- [UsageSummary](/reference/schemas/UsageSummary.md)
- [RuntimeAllowance](/reference/schemas/RuntimeAllowance.md)
- [ApiKeyList](/reference/schemas/ApiKeyList.md)
- [CredentialList](/reference/schemas/CredentialList.md)
- [ConnectionList](/reference/schemas/ConnectionList.md)
- [AgentList](/reference/schemas/AgentList.md)
- [AgentVersionList](/reference/schemas/AgentVersionList.md)
- [SessionList](/reference/schemas/SessionList.md)
- [SubmissionList](/reference/schemas/SubmissionList.md)
- [EntryList](/reference/schemas/EntryList.md)
- [ApiKey](/reference/schemas/ApiKey.md)
- [CreatedApiKey](/reference/schemas/CreatedApiKey.md)
- [ProviderApiKey](/reference/schemas/ProviderApiKey.md)
- [CreateCredential](/reference/schemas/CreateCredential.md)
- [Credential](/reference/schemas/Credential.md)
- [CreateModelCredential](/reference/schemas/CreateModelCredential.md)
- [ModelCredential](/reference/schemas/ModelCredential.md)
- [CreateSandboxCredential](/reference/schemas/CreateSandboxCredential.md)
- [SandboxCredential](/reference/schemas/SandboxCredential.md)
- [CreateWebSearchCredential](/reference/schemas/CreateWebSearchCredential.md)
- [WebSearchCredential](/reference/schemas/WebSearchCredential.md)
- [CreateBrowserCredential](/reference/schemas/CreateBrowserCredential.md)
- [BrowserCredential](/reference/schemas/BrowserCredential.md)
- [ToolEndpointCredentials](/reference/schemas/ToolEndpointCredentials.md)
- [CreateConnection](/reference/schemas/CreateConnection.md)
- [Connection](/reference/schemas/Connection.md)
- [AgentConfig](/reference/schemas/AgentConfig.md)
- [AgentModel](/reference/schemas/AgentModel.md)
- [Sandbox](/reference/schemas/Sandbox.md)
- [ToolGrant](/reference/schemas/ToolGrant.md)
- [Agent](/reference/schemas/Agent.md)
- [AgentVersion](/reference/schemas/AgentVersion.md)
- [Session](/reference/schemas/Session.md)
- [SessionLifecycle](/reference/schemas/SessionLifecycle.md)
- [SessionOverrides](/reference/schemas/SessionOverrides.md)
- [CreateSubmission](/reference/schemas/CreateSubmission.md)
- [InputContent](/reference/schemas/InputContent.md)
- [InputBlock](/reference/schemas/InputBlock.md)
- [Submission](/reference/schemas/Submission.md)
- [Entry](/reference/schemas/Entry.md)
- [ContentBlock](/reference/schemas/ContentBlock.md)
- [Message](/reference/schemas/Message.md)
- [ExecutionError](/reference/schemas/ExecutionError.md)
- [Usage](/reference/schemas/Usage.md)
- [CumulativeUsage](/reference/schemas/CumulativeUsage.md)
- [Inbox](/reference/schemas/Inbox.md)
- [Retry](/reference/schemas/Retry.md)
- [ToolDiagnostic](/reference/schemas/ToolDiagnostic.md)
- [ToolProgress](/reference/schemas/ToolProgress.md)
- [ToolCallList](/reference/schemas/ToolCallList.md)
- [ToolCall](/reference/schemas/ToolCall.md)
- [ToolActivity](/reference/schemas/ToolActivity.md)
- [Compaction](/reference/schemas/Compaction.md)
- [CompactionFailure](/reference/schemas/CompactionFailure.md)
- [State](/reference/schemas/State.md)
- [ExecutionEvent](/reference/schemas/ExecutionEvent.md)
- [MessageStarted](/reference/schemas/MessageStarted.md)
- [MessageDelta](/reference/schemas/MessageDelta.md)
- [MessageReplaced](/reference/schemas/MessageReplaced.md)
- [MessageCompleted](/reference/schemas/MessageCompleted.md)
- [ToolStarted](/reference/schemas/ToolStarted.md)
- [ToolOutputChange](/reference/schemas/ToolOutputChange.md)
- [ToolUpdated](/reference/schemas/ToolUpdated.md)
- [ToolCompleted](/reference/schemas/ToolCompleted.md)
- [RetryEnded](/reference/schemas/RetryEnded.md)
- [CompactionStarted](/reference/schemas/CompactionStarted.md)
- [CompactionCompleted](/reference/schemas/CompactionCompleted.md)
- [InboxUpdated](/reference/schemas/InboxUpdated.md)
- [ExecutionFailed](/reference/schemas/ExecutionFailed.md)
- [ModelList](/reference/schemas/ModelList.md)
- [File](/reference/schemas/File.md)
- [Artifact](/reference/schemas/Artifact.md)
- [ArtifactList](/reference/schemas/ArtifactList.md)
- [Webhook](/reference/schemas/Webhook.md)
- [CreatedWebhook](/reference/schemas/CreatedWebhook.md)
- [WebhookList](/reference/schemas/WebhookList.md)
- [WebhookEvent](/reference/schemas/WebhookEvent.md)
- [WebhookDelivery](/reference/schemas/WebhookDelivery.md)
- [WebhookDeliveryList](/reference/schemas/WebhookDeliveryList.md)