Models and agents¶
Use the linked wire models for field constraints. Operation metadata does not enumerate every possible HTTP error or replace current server authorization.
On this page¶
- Agents (GET)
- Agent create (POST)
- Agent update (PATCH)
- Agent validate (POST)
- Configuration (GET)
- Provider create (POST)
- Provider update (PUT)
- Provider validate (POST)
Agents¶
GET /api/v1/tenants/{tenant_id}/agents
Contract operation: AgentController.agents.
| SDK | Method |
|---|---|
| Python | agents |
| TypeScript | agents.list |
| Java | client.agents.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
q |
query | QueryParam[str] |
No | "" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
status |
query | QueryParam[str | None] |
No | null |
workspace_id |
query | QueryParam[str | None] |
No | null |
project_id |
query | QueryParam[str | None] |
No | null |
sort |
query | QueryParam[str] |
No | "name" |
order |
query | QueryParam[str] |
No | "asc" |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[AgentConfiguration] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Agent create¶
POST /api/v1/tenants/{tenant_id}/agents
Contract operation: AgentController.agent_create.
| SDK | Method |
|---|---|
| Python | create_agent |
| TypeScript | agents.create |
| Java | client.agents.create |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[AgentInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AgentInput |
| Response schema | AgentConfiguration |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Agent update¶
PATCH /api/v1/tenants/{tenant_id}/agents/{agent_id}
Contract operation: AgentController.agent_update.
| SDK | Method |
|---|---|
| Python | update_agent |
| TypeScript | agents.update |
| Java | client.agents.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
agent_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[AgentInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AgentInput |
| Response schema | AgentConfiguration |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Agent validate¶
POST /api/v1/tenants/{tenant_id}/agents/{agent_id}/validate
Contract operation: AgentController.agent_validate.
| SDK | Method |
|---|---|
| Python | validate_agent |
| TypeScript | agents.validate |
| Java | client.agents.validate |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
agent_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | AgentConfiguration |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Configuration¶
GET /api/v1/tenants/{tenant_id}/configuration
Contract operation: ProviderController.configuration.
| SDK | Method |
|---|---|
| Python | configuration |
| TypeScript | configuration.get |
| Java | client.configuration.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Configuration |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Provider create¶
POST /api/v1/tenants/{tenant_id}/providers
Contract operation: ProviderController.provider_create.
| SDK | Method |
|---|---|
| Python | create_provider |
| TypeScript | providers.create |
| Java | client.providers.create |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[ProviderInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | ProviderInput |
| Response schema | ModelProvider |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Provider update¶
PUT /api/v1/tenants/{tenant_id}/providers/{provider_id}
Contract operation: ProviderController.provider_update.
| SDK | Method |
|---|---|
| Python | update_provider |
| TypeScript | providers.update |
| Java | client.providers.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
provider_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[ProviderInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | ProviderInput |
| Response schema | ModelProvider |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Provider validate¶
POST /api/v1/tenants/{tenant_id}/providers/{provider_id}/validate
Contract operation: ProviderController.provider_validate.
| SDK | Method |
|---|---|
| Python | validate_provider |
| TypeScript | providers.validate |
| Java | client.providers.validate |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
provider_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | ValidationResult |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.