tables

Suggest a description for a table

Write a short description of what a table holds, from its name and its column names and types.

A SUGGESTION, not a write: the response is put in front of the user to accept, edit or discard, and the table is only changed if they then save it. Cell values are never sent: the columns say what the table is about, and the rows are the customer data we have no reason to hand to a model to answer this question.

post/tables/{table_id}/describe/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/describe/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required

Response

Successful Response

descriptionstring required

A one- or two-sentence description of what the table holds, written from its column names and types. Never applied automatically: the caller puts it in the field and the user decides.

Changes

No recorded changes to this operation across all 1 revision of this API.