Studio
SQL console and table data browser/editor.
Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/sql" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{ "result": { "columns": [ "string" ], "duration_ms": 0, "rows": [ {} ], "row_count": 0, "truncated": true }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/tables"{ "tables": [ { "schema": "string", "table": "string", "type": "string" } ]}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Database schema name.
Table name.
Query Parameters
Maximum number of rows to return.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/tables/string/string/rows"{ "result": { "columns": [ "string" ], "rows": [ {} ] }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Database schema name.
Table name.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/tables/string/string/rows" \ -H "Content-Type: application/json" \ -d '{}'{ "result": { "rows_affected": 0, "rows": [ {} ] }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Database schema name.
Table name.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/projects/string/tables/string/string/rows" \ -H "Content-Type: application/json" \ -d '{}'{ "result": { "rows_affected": 0, "rows": [ {} ] }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Database schema name.
Table name.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/projects/string/tables/string/string/rows" \ -H "Content-Type: application/json" \ -d '{}'{ "result": { "rows_affected": 0, "rows": [ {} ] }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Database schema name.
Table name.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/tables/string/string/columns"{ "columns": [ { "data_type": "string", "default": "string", "is_nullable": true, "is_primary_key": true, "name": "string", "position": 0 } ]}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
Project id.
Query Parameters
Maximum number of history entries to return (default 50).
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/sql/history"{ "history": [ { "actor_id": "string", "actor_kind": "string", "created_at": "2019-08-24T14:15:22Z", "duration_ms": 0, "error": "string", "id": "string", "organization_id": "string", "project_id": "string", "query": "string", "row_count": 0, "success": true } ]}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}