factqlDocs
Get an API key
API · Schema status

Schema status

GET/clients/{client_id}/schema/status

Know when new data is ready to ask about. Poll it after an upload or a database connection.

curl "https://api.factql.ai/clients/$CLIENT_ID/schema/status?workspace_id=$WORKSPACE_ID" \
  -H "X-API-Key: $FACTQL_API_KEY"
Path
client_idstring · required
Your tenant, from GET /whoami.
Query
workspace_idstring
The workspace to check. Send it whenever you have one.

Response

200
{
  "client_id": "tenant-f568009e0b87",
  "status": "ready",
  "table_count": 1,
  "discovered_at": "2026-09-16T17:30:33",
  "enrichment_completed_at": "2026-09-16T17:31:02",
  "updated_at": "2026-09-16T17:31:02"
}
not_startedNo data has been added yet.
discoveringReading the tables and columns.
enrichingDescribing what each column means, so questions map to the right data.
readyAsk away.
failedSomething went wrong. Re-upload the file or reconnect the database.

A small file is usually ready within a minute or two; a large database takes longer. Poll every 10 seconds or so. Right after an upload the status can still read not_startedfor a moment before discovery begins, so don't treat it as “no data” on the first check. Give up after a sensible limit, as the examples do.

Errors
401The key is missing, invalid or revoked.
403The key belongs to a different tenant.