Sign in
Database table fields

Endpoint that's used by the AI field to start an sync task that will update the cell value of the provided row IDs based on the dynamically constructed prompt configured in the field settings. This is a premium feature.

post/api/database/fields/{field_id}/generate-ai-field-values/

Path parameters

field_idinteger required

The field to generate the value for.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

ClientUndoRedoActionGroupIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Request body

row_idsinteger[] required

The ids of the rows that the values should be generated for.

Response

idinteger required
typestring required

The type of the job.

progress_percentageinteger required

A percentage indicating how far along the job is. 100 means that it's finished.

statestring required

Indicates the state of the import job.

human_readable_errorstring

A human readable error message indicating what went wrong.

error_codestring

A machine readable error code indicating why the job failed.

created_onstring date-time required
updated_onstring date-time required
field_idinteger required

The ID of the AI field to generate values for.

row_idsinteger[]

The IDs of the rows to generate AI values for. If not provided, all rows in the view or table will be processed.

view_idinteger

The ID of the view to generate AI values for. If not provided, the entire table will be processed.

only_emptyboolean

Whether to only generate AI values for rows where the field is empty.

is_auto_updateboolean required

Indicates if the job has been created because values in a dependent field changed.

Changes

Changed in 2 of the 6 revisions of this API.11

  • ea4a3480f8d31See the full diff
    • ○

      added the optional property error_code to the response with the 202 status

      response-optional-property-added

  • 80d3f3a0f3591See the full diff
    • ●

      added the new ERROR_AI_FIELD_PROMPT_INVALID enum value to the error response property for the response status 400

      response-property-enum-value-added