Returning.AIDevelopers
v1

API reference / Legacy / Servers

.md

Create server

Create server

Last updated 26 Sep 2026API v1

Method
POST
Path
https://api.returning.ai/servers

Authentication#

Header
Authorization: Bearer <API_KEY>

Behaviour#

Legacy category

This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.

What it is for

Create server.

How to use it

Send a POST request to /servers with the documented body, query parameters, headers, or multipart fields. Prefer the newer authenticated /v1/... integration API where available.

Successful response

HTTP 2xx. Older endpoints may return a legacy response envelope or a resource-specific payload rather than the newer { status, message, data } wrapper.

Common error states
  • 400 invalid request body, query, ObjectId, pagination, file format, or missing required field.
  • 401 missing, invalid, expired, or insufficient API key/token.
  • 403 key is valid but cannot access this community/channel/user/resource, where supported by the service.
  • 404 route or target resource was not found. Several legacy root routes return 404 on https://api.returning.ai; confirm with Returning.AI before using them.
  • 409 duplicate or conflicting state for create/update operations, where applicable.
  • 500 unexpected Returning.AI service error.
Legacy status

Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current /v1/... endpoint in the matching non-Legacy category when one exists.

Request#

Headers#

Authorization#stringREQUIRED
API key.

RuleBearer <API_KEY>

Body#

name#stringOPTIONAL
Display name.

Eg"Vise Neg"

Send the body as multipart/form-data.

curl --request POST \
  --url https://api.returning.ai/servers \
  --header 'Authorization: Bearer <API_KEY>' \
  --form 'name=Vise Neg'

Response#

meta#objectALWAYS

Eg{ ... }

success#booleanALWAYS

Egtrue

message#stringALWAYS

Eg"Server has been created successfully"

devMessage#stringALWAYS

Eg"Server has been created successfully"

body#objectALWAYS

Eg{ ... }

name#stringALWAYS

Eg"Galaxy Food And Drink"

image#stringALWAYS

Eg"https://chartsnapshot.s3.amazonaws.com/apireturningai/tester/1721923616255-d763c952a89131696dd3bdf79fa0108.png"

owner#objectALWAYS

Eg{"id": "2"}

id#stringALWAYS

Eg"2"

_id#stringALWAYS

Eg"{_id}"

__v#integerALWAYS

Eg0

id#stringALWAYS

Eg"{_id}"

{
  "meta": {
    "success": true,
    "message": "Server has been created successfully",
    "devMessage": "Server has been created successfully"
  },
  "body": {
    "name": "Galaxy Food And Drink",
    "image": "https://chartsnapshot.s3.amazonaws.com/apireturningai/tester/1721923616255-d763c952a89131696dd3bdf79fa0108.png",
    "owner": {
      "id": "2"
    },
    "_id": "{_id}",
    "__v": 0,
    "id": "{_id}"
  }
}

Errors#

Fix the request02

400Fix the request
Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values.
401Fix the request
Missing, invalid, expired, or insufficient API key/token. Older permission middleware may also return 401 for missing permissions.

Retry with backoff01

500Retry with backoff
Unexpected Returning.AI service error.
{
  "status": "fail",
  "message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}

Next step#

List serversGET/servers