> ## Documentation Index > Fetch the complete documentation index at: https://docs.talkpilot.io/llms.txt > Use this file to discover all available pages before exploring further. # Get agent status > Lightweight endpoint returning only the agent's active status and schedule, plus the computed `is_within_schedule`. Useful for monitoring dashboards. ## OpenAPI ````yaml get /v1/agents/{agentId}/status openapi: 3.1.0 info: title: TalkPilot API version: 1.0.0 description: > The TalkPilot API allows you to programmatically manage your call center agents, employees, forwarding slots, knowledge base, and more. ## Authentication All API requests require an API key passed via the `X-API-Key` header: ``` X-API-Key: tp_live_abc123def456... ``` An API key can reach every organization its creator is a member of (see `GET /v1/organization`) and can be restricted to specific agents and permissions. Create and manage keys in the TalkPilot Dashboard under **Settings > API** (Dev-Admin only). ## Rate Limiting Default limits per API key: **60 requests/minute** and **1,000 requests/hour** (both enforced, both configurable per key). Rate limit headers are included in every response to a request authenticated with an API key (Dashboard JWT requests are not rate limited): - `X-RateLimit-Limit` — Max requests per minute - `X-RateLimit-Remaining` — Remaining requests in the current minute window - `X-RateLimit-Reset` — Unix timestamp roughly 60 seconds in the future When rate limited, the API returns `429 Too Many Requests` with `Retry-After: 60` (minute window) or `Retry-After: 3600` (hour window). ## Pagination List endpoints support pagination via query parameters: - `page` — Page number (default: 1) - `limit` — Items per page (default: 20, max: 100) Paginated responses include a `pagination` object with `page`, `limit`, `total`, and `pages`. ## Error Format All errors follow a consistent format: ```json { "error": { "code": "VALIDATION_ERROR", "message": "Human-readable description", "details": [{ "field": "name", "message": "Required" }], "request_id": "req_abc123" } } ``` contact: name: TalkPilot Support email: support@talkpilot.io license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.talkpilot.io description: Production security: - apiKey: [] tags: - name: Health description: API health and status - name: Agents description: Manage AI agent configurations - name: Workflow description: Multi-state conversation flow of an agent - name: Tools description: Manage agent tools (HTTP requests, call transfers, etc.) - name: Employees description: Manage employees linked to agents - name: Contacts description: >- Customer contacts (customer_database) per agent — the voice agent recognises callers and greets them by name or tag from here - name: Forwarding Slots description: Manage call forwarding slot assignments - name: Knowledge Base description: Manage agent knowledge base documents - name: Calls description: Read call records and transcripts - name: Organization description: Organization-level settings - name: API Keys description: Manage API keys (Dashboard JWT auth only; dev_admin) paths: /v1/agents/{agentId}/status: get: tags: - Agents summary: Get agent status description: | Lightweight endpoint returning only the agent's active status and schedule, plus the computed `is_within_schedule`. Useful for monitoring dashboards. operationId: getAgentStatus parameters: - $ref: '#/components/parameters/AgentId' responses: '200': description: Agent status content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string is_active: type: boolean schedule: $ref: '#/components/schemas/AgentSchedule' is_within_schedule: type: boolean description: Whether the agent is currently within scheduled hours example: id: 550e8400-e29b-41d4-a716-446655440000 name: Rezeption Bot is_active: true schedule: timezone: Europe/Berlin rules: - days: - 1 - 2 - 3 - 4 - 5 start_time: '08:00' end_time: '18:00' is_within_schedule: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: AgentId: name: agentId in: path required: true description: Agent UUID schema: type: string format: uuid schemas: AgentSchedule: type: - object - 'null' description: | Agent business hours. When set, the agent only accepts calls during the specified time windows. Outside hours, calls go to the backup agent. properties: timezone: type: string description: IANA timezone identifier example: Europe/Berlin rules: type: array items: type: object required: - days - start_time - end_time properties: days: type: array items: type: integer minimum: 0 maximum: 6 description: Days of week (0=Sunday, 1=Monday, ..., 6=Saturday) example: - 1 - 2 - 3 - 4 - 5 start_time: type: string pattern: ^\d{2}:\d{2}$ description: Start time in HH:mm example: '08:00' end_time: type: string pattern: ^\d{2}:\d{2}$ description: End time in HH:mm example: '18:00' Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - AGENT_NOT_ACCESSIBLE - NOT_FOUND - CONFLICT - RATE_LIMITED - INTERNAL_ERROR message: type: string details: type: array items: type: object properties: field: type: string message: type: string request_id: type: string responses: Unauthorized: description: Missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UNAUTHORIZED message: Invalid or missing API key request_id: req_abc123 Forbidden: description: > Insufficient permissions (`FORBIDDEN`), or the agent is outside the key's `allowed_agent_ids` (`AGENT_NOT_ACCESSIBLE`) content: application/json: schema: $ref: '#/components/schemas/Error' examples: missingPermission: value: error: code: FORBIDDEN message: 'API key lacks required permission: agents:write' request_id: req_abc123 agentNotAccessible: value: error: code: AGENT_NOT_ACCESSIBLE message: API key does not have access to this agent request_id: req_abc123 NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: NOT_FOUND message: Agent not found request_id: req_abc123 RateLimited: description: Too many requests for this API key (60/minute or 1,000/hour by default) headers: Retry-After: description: >- Seconds to wait before retrying — 60 for the minute window, 3600 for the hour window schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RATE_LIMITED message: Rate limit exceeded. Try again in 60 seconds. request_id: req_abc123 securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: | API key for external access. Format: `tp_live_<32-hex-chars>`. Create keys in the TalkPilot Dashboard under Settings > API. ````