Wildcards
Named inputs a prompt can ask for, and how each is collected.
List wildcards
Returns the named inputs prompts can ask for, and how each one is collected.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$wildcard_activewildcard_control_typewildcard_createdwildcard_descriptionwildcard_idwildcard_managed_bywildcard_namewildcard_updatedHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List wildcards › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a wildcard
Declares an input a prompt can ask for. The control type decides how it is collected when the prompt runs.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a wildcard › Request Body
wildcard_namewildcard_control_typewildcard_descriptionwildcard_control_propsCreate a wildcard › Responses
Created
wildcard_idwildcard_namewildcard_descriptionwildcard_control_typewildcard_control_propswildcard_metadatawildcard_managed_bywildcard_activewildcard_createdwildcard_updatedGet a wildcard
Returns one wildcard with its control type and that control's settings.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a wildcard › Responses
Success
wildcard_idwildcard_namewildcard_descriptionwildcard_control_typewildcard_control_propswildcard_metadatawildcard_managed_bywildcard_activewildcard_createdwildcard_updatedDelete a wildcard
Prompts already referencing it keep the reference, so check before removing one in use.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a wildcard › Responses
Success. No content.
Update a wildcard
Applies the wildcard_-prefixed fields present in the body. Prompts referencing it by name pick the change up on their next run.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a wildcard › Request Body optional
wildcard_namewildcard_activewildcard_control_typewildcard_control_propsUpdate a wildcard › Responses
Success
wildcard_idwildcard_namewildcard_descriptionwildcard_control_typewildcard_control_propswildcard_metadatawildcard_managed_bywildcard_activewildcard_createdwildcard_updated