Schema

GET /api/v1/schema

Returns a machine-readable description of the trackagoat data model. Designed for AI agents that need to understand entity types, field names, and relationships without reading source code.

Request

bash

curl -H "Authorization: Bearer tga_<key>" \
  https://www.trackagoat.com/api/v1/schema

When to use this

Call /api/v1/schema when you first connect to the API to get a full picture of available entities and their fields. The response is stable across minor API updates — field names and types won't change without a version bump.

AI agents should call /api/v1/schema at the start of each session to orient themselves before querying data. See the Agent guide for more.

Response

The schema endpoint returns an object describing each entity type, its fields, and key relationships. The exact shape is controlled server-side and may expand over time.

json

{
  "data": {
    "entities": {
      "project": { "fields": {...}, "description": "..." },
      "creator": { "fields": {...}, "description": "..." },
      "video": { "fields": {...}, "description": "..." },
      "campaign": { "fields": {

Agent guide

How AI agents should connect to and use the trackagoat API.

API overview

Base URL, response envelope, pagination, and versioning.