Skip to main content

Get AI Tool Usage (v1)

Method & Path​

GET /api/v1/workspace/:workspaceId/ai/usages/:usageId

Description​

Get detailed information about a specific AI tool usage.

Authentication​

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with workspace permissions.

Headers​

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
usageIdstringYesAI tool usage identifier

Response 200 OK​

{
  "id": "507f1f77bcf86cd799439011",
  "workspaceId": "507f1f77bcf86cd799439012",
  "toolType": "product-marketing-post",
  "status": "completed",
  "cost": 0.10,
  "inputData": {
    "productName": "Product A",
    "description": "Amazing product"
  },
  "responseData": {
    "postText": "Check out our new Product A!",
    "overlaysSaved": [
      {
        "id": "overlay-1",
        "type": "text",
        "text": "New Product",
        "visible": true
      }
    ]
  },
  "createdAt": "2025-01-15T10:30:00.000Z",
  "completedAt": "2025-01-15T10:30:05.000Z"
}

Response Fields​

See List AI Tool Usages for field descriptions.

Common Errors​

401 Unauthorized: Missing or invalid authentication token

404 Not Found: Workspace or usage not found

500 Internal Server Error: Server error occurred while processing the request