{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Frontline Documentation","projectTitle":"","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"frontline-documentation","__idx":0},"children":["Frontline Documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Welcome to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Frontline Public API & Docs"]},". Our API gives you programmatic access to your CRM, agents, flows, workflows, tables, analytics, billing and more."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section covers the concepts and conventions of the API. For per-endpoint details see the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/reference/openapi"},"children":["API Reference"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-you-can-do","__idx":1},"children":["What you can do"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Manage your CRM"]}," — read and write Objects (People, Companies, Deals, and your own custom objects): record types, fields, rows, views, relations, notes, tasks, and files. This is the heart of Frontline, and everything else is built on top of it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Manage agents"]}," — list, create, update, deploy, and inspect AI agents, including their channel settings, intents, and the tools and models they can use."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Run automation workflows"]}," — define triggers, build the graph, manage workflow variables, and pull run analytics to see what fired and when."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Work with tables"]}," — manage spreadsheet-style datasets when you need lightweight, structured data that doesn't warrant a full CRM object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Track usage"]}," — inspect credits consumed, conversations by channel, and workflow analytics."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Billing"]}," — view your plan, remaining credits, and subscription renewal details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":2},"children":["Base URL"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://prod-api.getfrontline.ai\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Public API endpoints are prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"read-next","__idx":3},"children":["Read next"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting started"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/getting-started"},"children":["Getting started"]}]}," — your first authenticated request, step by step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/authentication"},"children":["Authentication"]}]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]}," vs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GENERAL"]}," keys and which endpoints need which."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/rate-limits"},"children":["Rate limits"]}]}," — current quotas and how to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," responses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/errors"},"children":["Errors"]}]}," — error envelope, status codes, and recommended client handling."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Core Concepts"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/objects#standard-objects"},"children":["Standard Objects"]}]}," — the built-in CRM objects: People, Companies, Deals, Tickets."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/objects"},"children":["Objects"]}]}," — CRM entities with record types and relations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/field-types"},"children":["Field Types"]}]}," — every field type, its metadata, defaults, and unique constraints."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/querying"},"children":["Querying and Filtering"]}]}," — JSON Query DSL to filter, search, and sort CRM objects and custom tables."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/record-types"},"children":["Record Types"]}]}," — categories within an Object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/tables"},"children":["Tables"]}]}," — spreadsheet-style datasets."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/agents"},"children":["Agents"]}]}," — the AI assistants you ship."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/flows"},"children":["Flows"]}]}," — conversation graphs that drive agent behavior."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/tools"},"children":["Tools"]}]}," — reusable HTTP integrations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/workflows"},"children":["Workflows"]}]}," — account-level automations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/workflow-variables"},"children":["Workflow Variables"]}]}," — variables scoped to a Workflow automation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/flow-variables"},"children":["Flow Variables"]}]}," — variables scoped to an agent's Flow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/intents"},"children":["Intents"]}]}," — NLP triggers inside an agent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/incoming-webhooks"},"children":["Incoming Webhooks"]}]}," — inbound HTTPS endpoints for external systems."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/ai-models"},"children":["AI Models"]}]}," — LLMs and transcription models available to your agents."]}]}]},"headings":[{"value":"Frontline Documentation","id":"frontline-documentation","depth":1},{"value":"What you can do","id":"what-you-can-do","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Read next","id":"read-next","depth":2}],"frontmatter":{"seo":{"title":"Frontline Documentation","projectTitle":""}},"lastModified":"2026-06-30T16:41:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}