/

Docs
History
Schema
Generate

Filter operations

post/v1/messagesCreate a Message
get/v1/modelsList Models
get/v1/models/{model_id}Get a Model
get/v1/messages/batchesList Message Batches
post/v1/messages/batchesCreate a Message Batch
get/v1/messages/batches/{message_batch_id}Retrieve a Message Batch
delete/v1/messages/batches/{message_batch_id}Delete a Message Batch
post/v1/messages/batches/{message_batch_id}/cancelCancel a Message Batch
get/v1/messages/batches/{message_batch_id}/resultsRetrieve Message Batch results
post/v1/messages/count_tokensCount tokens in a Message
get/v1/filesList Files
post/v1/filesUpload File
get/v1/files/{file_id}Get File Metadata
delete/v1/files/{file_id}Delete File
get/v1/files/{file_id}/contentDownload File
get/v1/skillsList Skills
post/v1/skillsCreate Skill
get/v1/skills/{skill_id}Get Skill
delete/v1/skills/{skill_id}Delete Skill
get/v1/skills/{skill_id}/versionsList Skill Versions
post/v1/skills/{skill_id}/versionsCreate Skill Version
get/v1/skills/{skill_id}/versions/{version}Get Skill Version
delete/v1/skills/{skill_id}/versions/{version}Delete Skill Version
post/v1/messages?beta=trueCreate a Message
get/v1/models?beta=trueList Models
get/v1/models/{model_id}?beta=trueGet a Model
get/v1/messages/batches?beta=trueList Message Batches
post/v1/messages/batches?beta=trueCreate a Message Batch
get/v1/messages/batches/{message_batch_id}?beta=trueRetrieve a Message Batch
delete/v1/messages/batches/{message_batch_id}?beta=trueDelete a Message Batch
post/v1/messages/batches/{message_batch_id}/cancel?beta=trueCancel a Message Batch
get/v1/messages/batches/{message_batch_id}/results?beta=trueRetrieve Message Batch results
post/v1/messages/count_tokens?beta=trueCount tokens in a Message
get/v1/files?beta=trueList Files
post/v1/files?beta=trueUpload File
get/v1/files/{file_id}?beta=trueGet File Metadata
delete/v1/files/{file_id}?beta=trueDelete File
get/v1/files/{file_id}/content?beta=trueDownload File
get/v1/skills?beta=trueList Skills
post/v1/skills?beta=trueCreate Skill
get/v1/skills/{skill_id}?beta=trueGet Skill
delete/v1/skills/{skill_id}?beta=trueDelete Skill
get/v1/skills/{skill_id}/versions?beta=trueList Skill Versions
post/v1/skills/{skill_id}/versions?beta=trueCreate Skill Version
get/v1/skills/{skill_id}/versions/{version}?beta=trueGet Skill Version
delete/v1/skills/{skill_id}/versions/{version}?beta=trueDelete Skill Version
get/v1/skills/{skill_id}/versions/{version}/content?beta=trueDownload Skill Version Content
get/v1/environments?beta=trueList Environments
post/v1/environments?beta=trueCreate Environment
get/v1/environments/{environment_id}?beta=trueGet Environment
post/v1/environments/{environment_id}?beta=trueUpdate Environment
delete/v1/environments/{environment_id}?beta=trueDelete Environment
post/v1/environments/{environment_id}/archive?beta=trueArchive Environment
get/v1/environments/{environment_id}/work/stats?beta=trueGet Queue Statistics
get/v1/environments/{environment_id}/work/poll?beta=truePoll for Work
post/v1/environments/{environment_id}/work/{work_id}/ack?beta=trueAcknowledge Work
post/v1/environments/{environment_id}/work/{work_id}/heartbeat?beta=trueRecord Heartbeat
post/v1/environments/{environment_id}/work/{work_id}/stop?beta=trueStop Work
get/v1/environments/{environment_id}/work/{work_id}?beta=trueGet Work Item
post/v1/environments/{environment_id}/work/{work_id}?beta=trueUpdate Work Item
get/v1/environments/{environment_id}/work?beta=trueList Work Items
get/v1/user_profilesList User Profiles
post/v1/user_profilesCreate User Profile
get/v1/user_profiles/{user_profile_id}Get User Profile
post/v1/user_profiles/{user_profile_id}Update User Profile
delete/v1/user_profiles/{user_profile_id}Delete User Profile
post/v1/user_profiles/{user_profile_id}/action_urlsCreate Action URL
get/v1/sessions?beta=trueList Sessions
post/v1/sessions?beta=trueCreate Session
get/v1/sessions/{session_id}?beta=trueGet Session
post/v1/sessions/{session_id}?beta=trueUpdate Session
delete/v1/sessions/{session_id}?beta=trueDelete Session
get/v1/sessions/{session_id}/events?beta=trueList Events
post/v1/sessions/{session_id}/events?beta=trueSend Events
get/v1/sessions/{session_id}/events/stream?beta=trueStream Events
post/v1/sessions/{session_id}/archive?beta=trueArchive Session
get/v1/sessions/{session_id}/threads?beta=trueList Session Threads
get/v1/sessions/{session_id}/threads/{thread_id}?beta=trueGet Session Thread
get/v1/sessions/{session_id}/threads/{thread_id}/events?beta=trueList Session Thread Events
get/v1/sessions/{session_id}/threads/{thread_id}/stream?beta=trueStream Session Thread Events
post/v1/sessions/{session_id}/threads/{thread_id}/archive?beta=trueArchive Session Thread
get/v1/sessions/{session_id}/resources?beta=trueList Session Resources
post/v1/sessions/{session_id}/resources?beta=trueAdd Session Resource
get/v1/sessions/{session_id}/resources/{resource_id}?beta=trueGet Session Resource
post/v1/sessions/{session_id}/resources/{resource_id}?beta=trueUpdate Session Resource
delete/v1/sessions/{session_id}/resources/{resource_id}?beta=trueDelete Session Resource
get/v1/agents?beta=trueList Agents
post/v1/agents?beta=trueCreate Agent
get/v1/agents/{agent_id}?beta=trueGet Agent
post/v1/agents/{agent_id}?beta=trueUpdate Agent
post/v1/agents/{agent_id}/archive?beta=trueArchive Agent
get/v1/agents/{agent_id}/versions?beta=trueList Agent Versions
get/v1/deployments?beta=trueList Deployments
post/v1/deployments?beta=trueCreate Deployment
get/v1/deployments/{deployment_id}?beta=trueGet Deployment
post/v1/deployments/{deployment_id}?beta=trueUpdate Deployment
post/v1/deployments/{deployment_id}/archive?beta=trueArchive Deployment
post/v1/deployments/{deployment_id}/pause?beta=truePause Deployment
post/v1/deployments/{deployment_id}/unpause?beta=trueUnpause Deployment
post/v1/deployments/{deployment_id}/run?beta=trueRun Deployment Now
post/v1/organizations/federation_rules/{federation_rule_id}/archiveArchive Federation Rule

Webhooks

postsession.createdsession.created webhook
postsession.pendingsession.pending webhook
postsession.runningsession.running webhook
postsession.idledsession.idled webhook
postsession.requires_actionsession.requires_action webhook
postsession.archivedsession.archived webhook
postsession.deletedsession.deleted webhook
postsession.status_rescheduledsession.status_rescheduled webhook
postsession.status_run_startedsession.status_run_started webhook
postsession.status_idledsession.status_idled webhook
postsession.status_terminatedsession.status_terminated webhook
postsession.thread_createdsession.thread_created webhook
postsession.thread_idledsession.thread_idled webhook
postsession.thread_terminatedsession.thread_terminated webhook
postsession.outcome_evaluation_endedsession.outcome_evaluation_ended webhook
postvault.createdvault.created webhook
postvault.archivedvault.archived webhook
postvault.deletedvault.deleted webhook
postvault_credential.createdvault_credential.created webhook
postvault_credential.archivedvault_credential.archived webhook
postvault_credential.deletedvault_credential.deleted webhook
postvault_credential.refresh_failedvault_credential.refresh_failed webhook
postsession.updatedsession.updated webhook
postagent.createdagent.created webhook
postagent.archivedagent.archived webhook
postagent.deletedagent.deleted webhook
postdeployment.pauseddeployment.paused webhook
postdeployment_run.faileddeployment_run.failed webhook
postdeployment.createddeployment.created webhook
postdeployment.updateddeployment.updated webhook
postdeployment.unpauseddeployment.unpaused webhook
postagent.updatedagent.updated webhook
postdeployment.archiveddeployment.archived webhook
postdeployment_run.starteddeployment_run.started webhook
postdeployment.deleteddeployment.deleted webhook
postdeployment_run.succeededdeployment_run.succeeded webhook
postenvironment.createdenvironment.created webhook
postenvironment.updatedenvironment.updated webhook
postenvironment.archivedenvironment.archived webhook
postenvironment.deletedenvironment.deleted webhook
postmemory_store.createdmemory_store.created webhook
postmemory_store.archivedmemory_store.archived webhook
postmemory_store.deletedmemory_store.deleted webhook
postsession.budget_reachedsession.budget_reached webhook
postuser_profile.enforcement_action_openeduser_profile.enforcement_action_opened webhook
postuser_profile.enforcement_action_resolveduser_profile.enforcement_action_resolved webhook

Changes to Archive Federation Rule

post/v1/organizations/federation_rules/{federation_rule_id}/archive

Sep 30, 202651c5260134e8 Revision changes
- info
  endpoint added