What the models look like

The schema deployed on your credential’s plane: every model with its fields, their types, and its relations. Read this when you have no local schema declaration to read types from — it is what makes a field typo a local check rather than a rejected write. Each model carries a content hash that moves only when its shape does, so read the shape once and poll the hashes after: a refetch only ever answers a push.

GET/v1/schema

Responses

200The deployed schema, or `active: false` when nothing is pushed.

One of:

object

activebooleanrequired

environmentstringrequired

projectstring | anyrequired

Show properties

Any of:

string

string

any

any

modelsobject[]required

Show properties

Array of object

keystringrequired

typenamestringrequired

conflictobject | anyrequired

Show properties

Any of:

object

userstring

Allowed:rejectoverwritenotify

agentstring

Allowed:rejectoverwritenotify

systemstring

Allowed:rejectoverwritenotify

any

any

hashstringrequired

fieldsobject

relationsobject

object

activebooleanrequired

environmentstringrequired

projectstring | anyrequired

Show properties

Any of:

string

string

any

any

modelsobject[]required

Show properties

Array of object

keystringrequired

typenamestringrequired

conflictobject | anyrequired

Show properties

Any of:

object

userstring

Allowed:rejectoverwritenotify

agentstring

Allowed:rejectoverwritenotify

systemstring

Allowed:rejectoverwritenotify

any

any

hashstringrequired

fieldsobject

relationsobject

schemaIdstringrequired

versionnumberrequired

hashstringrequired

pushedAtstring | anyrequired

Show properties

Any of:

string

string

any

any

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

401The Bearer credential is missing, malformed, or expired.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

404The addressed resource does not exist in the credential scope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

409The request conflicts with current claim, version, or idempotency state.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

500The server could not complete the request.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X GET "https://api.abloatai.com/api/v1/schema"

const response = await fetch("https://api.abloatai.com/api/v1/schema", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.abloatai.com/api/v1/schema",
)

Response

{
  "active": false,
  "environment": "string",
  "project": "string",
  "models": [
    {
      "key": "string",
      "typename": "string",
      "conflict": {
        "user": "reject",
        "agent": "reject",
        "system": "reject"
      },
      "hash": "string",
      "fields": {},
      "relations": {}
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}