|- The AI Agent Registrations API provides registration and lifecycle management operations for AI agents. A single app can have multiple AI agents linked to it. A single app can have multiple AI agents linked to it. See Register an AI agent.
Note: This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Okta for AI Agents is available in Early Access. Contact Okta Support for more information.
Lists all AI agents
| after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
| limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
| search | string <scim-filter> Searches for AI agents with a filtering expression that supports:
Example: search=profile.name sw "Demo Agent" and status eq "ACTIVE" and appId eq "0oa1qmn4LZQQEH0wZ0g4" |
OK
Forbidden
Too Many Requests
{- "data": [
- {
- "id": "wlpx9jQ16k9V8IFEL0g3",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z",
- "status": "ACTIVE",
- "appId": "0oab1234EXAMPLEID5d6",
- "profile": {
- "name": "Demo Agent",
- "description": "Demo Agent"
}, - "_links": {
- "self": {
- "rel": "self",
- "method": "GET"
}
}
}
], - "_links": {
- "self": {
- "rel": "self",
}, - "next": {
- "rel": "next",
}
}
}Registers an AI agent
Accepted
Bad Request
Forbidden
Too Many Requests
{- "appId": "0oab1234EXAMPLEID5d6",
- "profile": {
- "name": "Demo Agent",
- "description": "Demo Conversational AI Agent"
}
}{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}Retrieves an AI agent
OK
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "wlpx9jQ16k9V8IFEL0g3",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z",
- "status": "ACTIVE",
- "appId": "0oab1234EXAMPLEID5d6",
- "profile": {
- "name": "Demo Agent",
- "description": "Demo Agent"
}, - "_links": {
- "self": {
- "rel": "self",
- "method": "GET"
}
}
}Replaces an AI agent
Accepted
Bad Request
Forbidden
Too Many Requests
{- "appId": "0oab1234EXAMPLEID5d6",
- "profile": {
- "name": "Demo Agent",
- "description": "Demo Conversational AI Agent"
}
}{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}Updates an AI agent. Use this request to perform partial updates on AI agent profile properties.
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "appId": "0oab1234EXAMPLEID5d6",
- "profile": {
- "name": "Updated name",
- "description": "Updated description"
}
}{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}Deletes an AI agent
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "errorCauses": [
- {
- "errorSummary": "string"
}
], - "errorCode": "string",
- "errorId": "string",
- "errorLink": "string",
- "errorSummary": "string"
}Activates an AI agent
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}Deactivates an AI agent
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}Lists all AI agent operations. Operations are sorted in descending order from most recent to oldest by creation time.
| after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
| limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
OK
Bad Request
Forbidden
Not Found
Too Many Requests
{- "data": [
- {
- "id": "op-1a2b3c4d",
- "type": "ai-agent:Register",
- "status": "COMPLETED",
- "created": "2025-09-11T18:52:48.000Z",
- "started": "2025-09-11T18:52:48.000Z",
- "completed": "2025-09-11T18:52:49.000Z",
- "resource": {
- "id": "aiAgent_abc123def456",
- "type": "AI_AGENT",
- "status": "ACTIVE",
- "_links": {
}
}
}, - {
- "id": "op-0f1e2d3c",
- "type": "ai-agent:Replace",
- "status": "IN_PROGRESS",
- "created": "2025-09-10T15:00:00.000Z",
- "started": "2025-09-10T15:00:01.000Z"
}, - {
- "id": "op-2b3c4d5e",
- "type": "ai-agent:Delete",
- "status": "FAILED",
- "created": "2025-09-10T14:30:00.000Z",
- "started": "2025-09-10T14:30:01.000Z",
- "completed": "2025-09-10T14:30:05.000Z",
- "errorDetails": {
- "code": "E0000001",
- "message": "custom error message."
}
}
], - "_links": {
}
}Retrieves an AI agent operation and its status
OK
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "op-1a2b3c4d",
- "type": "ai-agent:Register",
- "status": "COMPLETED",
- "created": "2025-09-11T18:52:48.000Z",
- "started": "2025-09-11T18:52:48.000Z",
- "completed": "2025-09-11T18:52:49.000Z",
- "resource": {
- "id": "aiAgent_abc123def456",
- "type": "AI_AGENT",
- "status": "ACTIVE",
- "_links": {
}
}
}