> ## Documentation Index > Fetch the complete documentation index at: https://docs.teamfollowup.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the public API base URL: https://api.teamfollowup.ai/api. > Authenticate public API requests with Authorization: Bearer YOUR_API_KEY. > Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers. > Scope requests by locationId rather than projectName. > Read the guide linked from each API reference group before recommending an endpoint. # List agent skills > Return every skill with its editable content and current version. Use the digest endpoint when you only need to choose a skill. Use `view=summary` for names, purposes, IDs and versions without full instructions. Required API key scope: `agents:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/agents/{id}/skills openapi: 3.1.0 info: title: TFUAI Server API version: 1.0.0 description: >- API reference for the TFUAI SaaS server. All published endpoints are mounted under `/api`. Responses use a standard envelope: `{ "success": true, ... }` on success and `{ "success": false, "error": "..." }` on failure. Product API modules are being launched module by module. This spec currently exposes only contracted public modules. Authenticate public API requests with an API key in the `Authorization` header: `Authorization: Bearer YOUR_API_KEY`. servers: - url: https://api.teamfollowup.ai description: Production API origin. Public API paths are under /api. security: [] tags: - name: Agents description: >- Build the conversation: identity and settings, script, lead context and split testing. - name: Analytics description: >- Understand call volume, pickup, booking and transfer metrics within the selected reporting scope. - name: Billing description: >- Balances, spend, purchases and sub-account rebilling. Reference and guides only; the builder chatbot has no billing playbook. - name: Calls description: >- Review completed calls, recordings, transcripts and campaign run history; distinguish observation from placing a new call. - name: Campaigns description: >- Configure what starts calls, who is eligible, calling windows, caller IDs, activation and the actions that follow each outcome. What runs after a call lands: for each outcome (booked, opted out, asked for a callback…), an ordered chain of actions — tag the contact, move a pipeline stage, send an SMS, book an appointment. Stored as a graph: `nodes` are the actions, `edges` say what follows what, and `dispositionEntries` maps each outcome to the node its chain starts at. **Pick the narrowest endpoint that does the job.** | To | Call | | | --- | --- | --- | | See what fires per outcome | `GET .../workflow?view=summary` | Reads as plain text, no graph walking | | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server derives node ids, edge ids, handles, layout | | Change a message, tag or setting | `PATCH .../workflow` | Merges; carries no graph, so it cannot damage one | | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain around it | | Author or replace the whole graph | `PUT .../workflow` | Replaces everything you send | `PUT` is the only one that can re-wire, position nodes, build an `if`, save an unconfigured draft, or copy a whole workflow — and the only one that can overwrite a change someone else made after you read it. Use it when you are genuinely authoring the graph, and send `expectedVersion` when you do. For everything else the narrower endpoints are both easier and safer. - name: Contacts description: >- Find contacts and their calls, manage do-not-call status and identify internal contacts excluded from reporting. - name: In-call Capabilities description: >- Configure actions and instructions the agent uses during a live call: booking, transfers, lookups and custom skills. - name: Master agent description: >- Run a shared agent and campaign across linked projects; manage inheritance, local bindings, synchronization and rollout readiness. - name: Native Calendar description: >- The diary of a sub-account with no CRM: its bookable calendars, the free slots they offer, and the appointments on them. Availability is computed per request against live bookings and is never cached, because a cached slot is one somebody else has already taken. - name: Native Contacts description: >- The people a sub-account with no CRM calls, and the fields it keeps on them. This is the system of record for those contacts: there is nowhere else they exist. A sub-account with a CRM keeps its contacts there and every operation here answers 400 for it. - name: Phone Numbers description: >- Find and manage caller IDs, assign numbers to campaigns and understand connected Twilio numbers. - name: Projects description: >- Understand project ownership, inspect configuration and validate the local resources used by a campaign. - name: TFU Live description: >- Build one TFU Live agent with its Brain, Voice and equipped actions; connect it through shared Campaigns. - name: Voices description: >- Browse the voice catalogue and select a voice; configure speech and listening behavior in Agents. paths: /api/agent-builder/agents/{id}/skills: get: tags: - In-call Capabilities summary: List agent skills description: >- Return every skill with its editable content and current version. Use the digest endpoint when you only need to choose a skill. Use `view=summary` for names, purposes, IDs and versions without full instructions. Required API key scope: `agents:read`. operationId: get-agent-builder-agents-by-id-skills parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id. example: agent_8a488fcfa8fdbf8ce8ad5ccc45 - name: view in: query required: false description: >- Choose the smallest representation needed for the task. Omit for full. schema: type: string enum: - full - summary default: full responses: '200': description: Agent skills. content: application/json: schema: oneOf: - $ref: '#/components/schemas/SkillsListResponse' - $ref: '#/components/schemas/SkillsDigestResponse' examples: default: value: success: true skills: - id: pricing_objections type: instructions name: Pricing objections whenToUse: The caller says the service costs too much. enabled: true instructions: >- Acknowledge the concern, explain the value, and never invent a discount. version: 4 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: SkillsListResponse: type: object additionalProperties: false properties: success: type: boolean const: true skills: type: array items: $ref: '#/components/schemas/SkillsSkill' version: type: integer minimum: 0 required: - success - skills - version SkillsDigestResponse: type: object additionalProperties: false properties: success: type: boolean const: true digest: type: array items: $ref: '#/components/schemas/SkillsDigestItem' version: type: integer minimum: 0 required: - success - digest - version SkillsSkill: oneOf: - $ref: '#/components/schemas/SkillsInstructionsSkill' - $ref: '#/components/schemas/SkillsServiceAreaSkill' - $ref: '#/components/schemas/SkillsLiveTransferSkill' - $ref: '#/components/schemas/SkillsAddTagSkill' - $ref: '#/components/schemas/SkillsCheckTagSkill' - $ref: '#/components/schemas/SkillsAppointmentBookingSkill' discriminator: propertyName: type SkillsDigestItem: type: object additionalProperties: false properties: id: type: string type: type: string enum: - instructions - smart_service_area - live_transfer - add_tag - check_tag - appointment_booking name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. instructionsLength: type: integer minimum: 0 zipCount: type: integer minimum: 0 hasOutOfAreaResponse: type: boolean transferNumber: type: string transferMessage: type: string tagCount: type: integer minimum: 0 required: - id - type - name - whenToUse - enabled ApiError: type: object description: Standard error envelope returned by the API. properties: success: type: boolean example: false error: type: string description: Short machine-readable error code. example: Unauthorized message: type: string description: Human-readable explanation of the error. example: Authentication required. required: - success - error SkillsInstructionsSkill: title: Custom instruction skill description: >- A plain-English playbook that teaches the agent when and how to handle a use case. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: instructions name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. instructions: type: string minLength: 1 maxLength: 12000 pattern: \S description: >- The playbook the agent follows once the trigger lands. Longer input is truncated to this length and saved; it is not rejected. Leading and trailing whitespace is stripped before validation, so a value that is only whitespace counts as empty. required: - type - name - instructions SkillsServiceAreaSkill: title: Service area check description: A deterministic ZIP coverage check the agent can use during a call. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: smart_service_area name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. zips: type: string minLength: 1 maxLength: 4000 pattern: \d{5} description: >- Coverage list, separated by commas or line breaks. Only five-digit US ZIP codes are recognised: the server extracts every run of five digits and ignores the rest, so a list of non-US postcodes parses to nothing and is rejected. Longer input is truncated to this length and saved; it is not rejected. outOfAreaResponse: type: string maxLength: 400 default: '' description: >- What the agent should do when the caller's ZIP is outside the list. Longer input is truncated to this length and saved; it is not rejected. required: - type - name - zips SkillsLiveTransferSkill: title: Live transfer description: A configured human transfer destination the agent can use during a call. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: live_transfer name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. transferNumber: type: string maxLength: 40 pattern: ^$|^\+[1-9]\d{6,14}$ description: >- Destination phone number in E.164 format, for example `+14155550100`. A national or formatted number such as `(415) 555-0100` is rejected. May be omitted or left empty to save the skill as a draft; the campaign cannot go live until a destination is set. example: '+14155550100' transferMessage: type: string maxLength: 400 default: '' description: >- What the agent says as it hands the call over. Either the exact sentence to speak or a direction to follow — the server prepends a framing line that tells the model to read it either way. Omitted, empty, or whitespace-only all keep the default line, `Just a second while I connect you`. Longer input is truncated to this length and saved; it is not rejected. Leading and trailing whitespace is stripped before validation, so a value that is only whitespace counts as empty. example: Tell them you are putting them through to the team now. required: - type - name SkillsAddTagSkill: title: Add a tag description: >- A GoHighLevel action that lets the agent add one of the configured tags during a call. Needs a sub-account with GoHighLevel connected. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: add_tag name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. tags: type: string maxLength: 1500 description: >- Tags the agent may apply, separated by commas or line breaks. Case is kept as typed; duplicates are removed case-insensitively. Up to 30 tags, each truncated to 100 characters. May be omitted or left empty to save the skill as a draft, in which case the tool is installed in a fail-closed state that applies nothing until at least one tag is set. Longer input is truncated to this length and saved; it is not rejected. example: qualified_lead, hot required: - type - name SkillsCheckTagSkill: title: Check a tag description: >- A GoHighLevel lookup that lets the agent check for one of the configured tags during a call. Needs a sub-account with GoHighLevel connected. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: check_tag name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. tags: type: string maxLength: 1500 pattern: ^\s*[^,\n]+\s*,?\s*$ description: >- The single tag to check for. Unlike Add a Tag, this takes EXACTLY ONE tag: supplying two or more is rejected with "can only check one tag", and supplying none is rejected too. There is no draft state for this skill. example: existing_customer checkingMessage: type: string maxLength: 200 default: '' description: >- What the agent says while the lookup runs. Longer input is truncated to this length and saved; it is not rejected. required: - type - name - tags SkillsAppointmentBookingSkill: title: Appointment booking description: >- Lets the agent offer real calendar availability and book the time the lead accepts. It carries no settings of its own: the calendar it books against is campaign configuration, and the campaign cannot go live until one is set. type: object additionalProperties: {} properties: id: type: string minLength: 1 description: Stable skill id. Generated when omitted during creation. type: type: string const: appointment_booking name: type: string minLength: 1 maxLength: 120 pattern: \S description: >- Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty. whenToUse: type: string maxLength: 300 default: '' description: >- Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected. enabled: type: boolean default: true description: >- Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed. required: - type - name responses: ValidationError: description: Validation failed / malformed request. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: Authenticated but not permitted (role or tenant scope). content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ApiError' ServerError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````