Skip to main content
API docs by Redocly

Zudello API Placeholder (1.0.0)

Download OpenAPI specification:Download

Replace this file with your actual OpenAPI specification.

Users

List all users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new user

Request Body schema: application/json
required
name
required
string
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com"
}

Info for a specific user

path Parameters
userId
required
string <uuid>

The id of the user to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com"
}

Update a specific user

path Parameters
userId
required
string <uuid>

The id of the user to update

Request Body schema: application/json
required

Updated user information

name
required
string
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com"
}

Delete a specific user

path Parameters
userId
required
string <uuid>

The id of the user to delete

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Documents

List documents

query Parameters
limit
integer <int32> <= 100
Default: 20

How many documents to return at once (max 100)

status
string
Enum: "pending" "processed" "error"

Filter by document status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload a new document

Request Body schema: multipart/form-data
required
file
string <binary>
metadata
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get document details

path Parameters
documentId
required
string

ID of the document

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Delete a document

path Parameters
documentId
required
string

ID of the document to delete

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Workflows

List workflows

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Run a specific workflow

path Parameters
workflowId
required
string

ID of the workflow to run

Request Body schema: application/json
optional

Input data for the workflow

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}