Sign in
Agents

Define a form using AI assistance

Uses AI to generate or refine a form definition based on the provided prompt.

post/api/agents/forms/define

Request body

promptstring required

The prompt to guide the AI in form definition.

definitionstring nullable

Optional existing form definition to refine or modify.

agentNamestring

Optional assistant ID for continuing a conversation.

threadIdinteger nullable

Optional thread ID for continuing a conversation.

formIdinteger nullable

Optional form ID to associate the conversation with a specific form.

Response

Form definition generated successfully.

agentIdstring

The agent ID for continuing the conversation.

threadIdstring

The thread ID for continuing the conversation.

Changes

Changed in 3 of the 7 revisions of this API.312

  • a99906323223211See the full diff
    • ▲

      added DefineFormResponse_AgentMessage to the agentResponse response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the agentResponse response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property definition from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property userPrompt to the response with the 200 status

      response-optional-property-added

  • 50eff5014b781See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fbc3fe6ecbf11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog