Skip to content
JITSudo Docs

Create an AI agent

POST
/v1/agents
 
curl --request POST \
  --url https://example.com/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --data '{ "name": "example", "display_name": "example", "type": "reviewer", "instructions": "example", "use_default_provider": true, "provider_type": "example", "model": "example", "model_hint": "fast", "config": {} }'

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
/^[a-z0-9][a-z0-9\-]{0,62}$/
display_name
required
string
type
required
string
Allowed values: reviewer
instructions
string
nullable
use_default_provider
required
boolean
provider_type
string
nullable
model
string
nullable
model_hint
string
nullable
Allowed values: fast balanced powerful
config
required
object
key
additional properties
any

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
id
required
string format: uuid
name
required
string
display_name
required
string
type
required
string
Allowed values: reviewer
instructions
string
nullable
use_default_provider
required
boolean
provider_type
string
nullable
model
string
nullable
model_hint
string
nullable
Allowed values: fast balanced powerful
config
required
object
key
additional properties
any
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example 
{
  "type": "reviewer",
  "model_hint": "fast"
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

409

Section titled “409 ”

Conflict (name already exists)

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

422

Section titled “422 ”

Unprocessable entity

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}