Inspector

Get Database Schema

List tables, views, and columns in the actor's SQLite database.

The inspector API is subject to change without notice. Do not build production integrations on it.

GET https://rivet.example.com/gateway/{actor}/inspector/database/schema

Examples

curl "https://rivet.example.com/gateway/$ACTOR_ID/inspector/database/schema" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN"

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/database/schema`,
	{ headers: { Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}` } },
);
console.log(await response.json());
export {};

Authentication

Inspector endpoints do not accept namespace tokens. Send the actor’s inspector token as a bearer token in the Authorization header.

Path Parameters

Name	Type	Required	Description
`actor`	`string`	Yes	Actor ID, actor ID with an inline token (`{actor_id}@{token}`), or actor name combined with the `rvt-*` query parameters.

Headers

Name	Type	Required	Description
`Authorization`	`string`	No	Bearer token for inspector authentication. Required in production, optional in development.

Responses

200

The actor database schema.

Field	Type	Description
`schema`	`object`
`schema.tables`	`object[]`
`schema.tables[].name`	`string`
`schema.tables[].type`	`"table" \| "view"`
`schema.tables[].columns`	`object[]`
`schema.tables[].columns[].name`	`string`
`schema.tables[].columns[].type`	`string`
`schema.tables[].columns[].notnull`	`boolean`
`schema.tables[].columns[].pk`	`boolean`

{
  "schema": {
    "tables": [
      {
        "name": "my-actor",
        "type": "table",
        "columns": [
          {
            "name": "my-actor",
            "type": "<type>",
            "notnull": false,
            "pk": false
          }
        ]
      }
    ]
  }
}

401

The inspector token is missing or invalid.