Form

Beta Release Notice: This API documentation is currently in beta and is primarily intended for developer preview. While the core functionality is stable, specific aspects including error codes, response formats, and endpoint behaviors may be refined or modified in future releases. We encourage developers to provide feedback, but recommend not using this version in production environments without understanding that breaking changes may occur. We will strive to communicate significant changes through our developer channels.

PreviousTransformation NextSearch

Last updated 1 day ago

List forms

get

/forms

Authorizations

Query parameters

include_sharedboolean

Include shared forms in the results

verboseboolean

Include full form objects in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/forms' \
  --header 'Authorization: Bearer JWT'

200

401

500

{
  "status": "success",
  "object_ids": [
    "text"
  ],
  "objects": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Successful response. When verbose=true, full form objects are included in the response

Fetch a form

get

/form

Authorizations

Query parameters

idstring

Optional form ID. If not provided, name parameter is required

namestring

Name of the form. Required if id is not provided

usernamestring

Optional username for name-based search

org_namestring

Optional organization name for name-based search

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/form' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

500

{
  "object": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "success"
}

Form details

Create a new form

post

/form

Authorizations

Body

pipelineobjectrequired

namestringrequired

descriptionstringrequired

deployment_optionsobjectrequired

access_configobjectrequired

deployedbooleanrequired

rbacbooleanrequired

inputobjectrequired

outputobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/form' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"pipeline":{"id":"text","version":"latest"},"name":"text","description":"text","deployment_options":{"ANY_ADDITIONAL_PROPERTY":"anything"},"access_config":{"ANY_ADDITIONAL_PROPERTY":"anything"},"deployed":true,"rbac":true,"input":{"ANY_ADDITIONAL_PROPERTY":{"name":"text","data_type":"text","is_selected":true,"required":true}},"output":{"ANY_ADDITIONAL_PROPERTY":{"name":"text","data_type":"text","is_selected":true,"required":true}}}'

200

400

401

500

{
  "id": "text",
  "status": "success"
}

Successful response

Run a form

Run a form with provided inputs. Supports both regular responses and SSE streaming.

post

/form/{id}/run

Authorizations

Path parameters

idstringrequired

Body

streamboolean

Enable server-sent events streaming

inputsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/form/{id}/run' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"stream":false,"inputs":{}}'

200

400

401

500

application/json

text/event-stream

{
  "run_id": "text",
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "success"
}

Successful response. Returns regular JSON response or SSE stream based on 'stream' parameter.

Delete a form

delete

/form/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.vectorshift.ai/v1/form/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

500

{
  "status": "success"
}

Successful response