---
title: "Suggest a description for a table"
method: POST
path: "/tables/{table_id}/describe/"
tags: ["tables"]
---

# Suggest a description for a table

`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

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.

## Path parameters

- `table_id` string, uuid, required

## Response `200`

Successful Response

- TableDescriptionSuggestionSchema: A generated description for a table, for the user to accept or edit.
  - `description` string, 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.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Table not found
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: The model could not suggest a description right now.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)