Skip to main content

Get Workspace Context

Get a comprehensive workspace overview including document stats, schemas, active runs, field registry summary, and recent activity for AI integrations.

The Agent API provides programmatic access to the same AI assistant capabilities available in the Talonic platform UI. Use the context endpoint to retrieve a comprehensive workspace snapshot, and the tools endpoint to discover all available agent capabilities.

The workspace context is useful for building external dashboards, feeding context into custom AI integrations, or monitoring workspace health. The response includes document processing stats, schema summaries, active extraction runs, field registry tier distribution, and up to 15 recent activity events.

GET/v1/agent/context

Response

Response fields

organizationNamestring | nullName of the authenticated organization.
documents.totalintegerTotal number of documents in the workspace.
documents.completedThisWeekintegerDocuments that completed extraction this week.
documents.completedLast24hintegerDocuments that completed extraction in the last 24 hours.
documents.processingintegerDocuments currently being processed.
documentTypesarrayArray of document type summaries with id, name, and documentCount.
schemasarrayArray of user-defined schema summaries with id, name, fieldCount, and version.
activeRunsarrayArray of active extraction runs with id, name, status, and documentCount.
fieldRegistry.totalFieldsintegerTotal fields in the registry.
fieldRegistry.tier1integerNumber of Tier 1 registry fields.
fieldRegistry.tier2integerNumber of Tier 2 registry fields.
fieldRegistry.tier3integerNumber of Tier 3 registry fields.
recentActivityarrayUp to 15 recent workspace activity events with type, message, timestamp, and actor.

Response

{
  "organizationName": "Phoenix",
  "documents": {
    "total": 810,
    "completedThisWeek": 155,
    "completedLast24h": 42,
    "processing": 3
  },
  "documentTypes": [
    { "id": "uuid", "name": "Invoice", "documentCount": 320 }
  ],
  "schemas": [
    { "id": "uuid", "name": "Invoice Header", "fieldCount": 12, "version": 3 }
  ],
  "activeRuns": [
    { "id": "uuid", "name": "Schema_V13", "status": "extraction", "documentCount": 142 }
  ],
  "fieldRegistry": {
    "totalFields": 245,
    "tier1": 80,
    "tier2": 120,
    "tier3": 45
  },
  "recentActivity": [
    {
      "type": "user_uploaded",
      "message": "42 documents uploaded",
      "timestamp": "2026-04-25T09:30:00Z",
      "actor": "Avi"
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

List Agent Tools