GET
/
api
/
agent-requests
/
{requestId}
Get Agent Request Status
curl --request GET \
  --url https://api.useagentkey.com/api/agent-requests/{requestId} \
  --header 'X-Client-ID: <api-key>'
{
  "success": true,
  "data": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "COMPLETED",
    "providerId": "550e8400-e29b-41d4-a716-446655440001",
    "providerName": "LinkedIn",
    "action": "Create a post with the text 'Hello world!'",
    "parameters": {
      "content": "Hello world!",
      "startingUrl": "https://linkedin.com/feed"
    },
    "result": {
      "postId": "urn:li:activity:1234567890",
      "postUrl": "https://linkedin.com/posts/user_activity-1234567890",
      "success": true
    },
    "executionTimeMs": 15420,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "startedAt": "2024-01-15T10:30:05.000Z",
    "completedAt": "2024-01-15T10:30:20.420Z"
  }
}

Authorizations

​
X-Client-ID
string
header
required

Client credential authentication requires two headers:

  • X-Client-ID: Your client identifier
  • X-Client-Secret: Environment-specific secret

Path Parameters

​
requestId
string
required

The ID of the agent request to check

Response

200
application/json

Agent request status retrieved successfully

The response is of type object.