Create an entry

post

https://api.andesine.app/entries

Creates an entry and its initial document, in the collection given by collectionID, collectionPath, or collectionSlugPath (the top level by default). The name defaults to Untitled, or comes from the title of the supplied document or mdx. fields sets property values and fragment MDX by field name or key. path places the entry at a full name path and creates missing parent collections; a name already used there is a conflict. A repeated request with the same Idempotency-Key header returns the first result for 24 hours. Creation selects an available sibling name with a numeric suffix when needed. Names are trimmed and NFC-normalized. Derived URL slugs must be unique across sibling entries and collections, including case and punctuation variants. Names cannot contain a slash or equal a single dot or two dots. A collection schema sets the initial content without a document; a document must match it.

Required API key permissions: entries. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Request body *

application/json

Bodyobject

9 fields

idstring

ID of the entry

namestring

Name of the entry

collectionIDstring

ID of the collection this entry belongs to

documentobject

ProseMirror JSON of the entry document, which must match the editor and the collection schema

5 fields

type*string

attrsobject

1 field

{key}any

contentarray of ContentNodeInput

5 fields

type*string

attrsobject

1 field

{key}any

contentarray of ContentNodeInput

Repeats ContentNodeInput

marksarray of ContentMark

2 fields

type*string

attrsobject

1 field

{key}any

textstring

marksarray of ContentMark

2 fields

type*string

attrsobject

1 field

{key}any

textstring

mdxstring

Content as MDX: the title as H1, properties as elements in place, fragments as elements, and images as asset:; frontmatter properties are also read, and entries.update and versions.create import image URLs

fieldsobject

Field values by name or key, set on the initial content

1 field

{key}any of

Property value, or MDX for a fragment

Options

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array of string

Option 5null

pathstring

Full name path of the entry, for example /Guides/Setup

collectionPathstring

Name path of an existing parent collection

collectionSlugPathstring

Slug path of an existing parent collection

Responses

200OKapplication/json

Bodyobject

6 fields

id*string

ID of the entry

name*string

Name of the entry

order*string

LexoRank order of the entry

collectionIDstring

ID of the collection this entry belongs to

path*string

slugPath*string

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: true

code*constant

Value: "CONTENT_FORMAT_INVALID"

status*constant

Value: 400

message*string

Default: "CONTENT_FORMAT_INVALID"

data*object

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

linenumber

Line of the error in the source

columnnumber

Column of the error in the source

Option 3object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: true

code*constant

Value: "CONTENT_NAME_CONFLICT"

status*constant

Value: 409

message*string

Default: "CONTENT_NAME_CONFLICT"

data*ContentNameConflictErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

name*string

slug*string

Conflicting URL slug derived from the name

parentID*any of

Options

Any of

Option 1string

Option 2null

Option 3object

defined*constant

Value: true

code*constant

Value: "CONTENT_SCHEMA_INVALID"

status*constant

Value: 409

message*string

Default: "CONTENT_SCHEMA_INVALID"

data*ContentSchemaInvalidErrorData

5 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

entryIDstring

versionIDstring

revisionID*any of

Options

Any of

Option 1string

Option 2null

issues*array of ContentSchemaIssue

4 fields

code*string

One of: "invalid_schema", "invalid_structure", "missing_field", "unknown_field", "duplicate_field", "field_kind_mismatch", "field_key_mismatch", "property_type_mismatch", "invalid_property_value", "invalid_field_options", "invalid_allowed_blocks", "invalid_fragment_content"

message*string

path*array of any of

Options

Any of

Option 1string

Option 2number

fieldIDstring

Option 4object

defined*constant

Value: true

code*constant

Value: "CONTENT_LINK_INVALID"

status*constant

Value: 409

message*string

Default: "CONTENT_LINK_INVALID"

data*object

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

href*string

Link that doesn't point to an entry

Option 5object

defined*constant

Value: true

code*constant

Value: "CONTENT_IMAGE_UNAVAILABLE"

status*constant

Value: 409

message*string

Default: "CONTENT_IMAGE_UNAVAILABLE"

data*object

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

url*string

Image URL in the content

assetID*string

Imported image

assetStatus*string

Status of the image when the write stopped waiting

Option 6object

defined*constant

Value: true

code*constant

Value: "IDEMPOTENCY_KEY_IN_PROGRESS"

status*constant

Value: 409

message*string

Default: "A request with this Idempotency-Key is in progress"

data*ErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 7object

defined*constant

Value: true

code*constant

Value: "SCHEMA_FIELD_KEY_CONFLICT"

status*constant

Value: 409

message*string

Default: "SCHEMA_FIELD_KEY_CONFLICT"

data*SchemaFieldKeyConflictErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

key*string

kind*string

One of: "fragment", "property"

fieldIDs*array of string

Option 8object

defined*constant

Value: true

code*constant

Value: "SCHEMA_MIGRATION_IN_PROGRESS"

status*constant

Value: 409

message*string

Default: "A schema migration is in progress for this collection"

data*SchemaMigrationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

migrationID*string

Option 9object

defined*constant

Value: false

code*string

status*number

message*string

dataany

422Unprocessable Contentapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "IDEMPOTENCY_KEY_REUSED"

status*constant

Value: 422

message*string

Default: "This Idempotency-Key was used with a different request"

data*ErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request POST \
  --url 'https://api.andesine.app/entries' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Getting started",
  "collectionID": "coll_example"
}'

javascript

const response = await fetch("https://api.andesine.app/entries", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "Getting started",
    "collectionID": "coll_example"
  })
});

const data = await response.json();

python

import requests

response = requests.post(
    "https://api.andesine.app/entries",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "name": "Getting started",
        "collectionID": "coll_example",
    },
)

print(response.json())

typescript

import { createClient } from "@andesine/sdk";

const client = createClient({ apiKey: process.env.ANDESINE_API_KEY });

await client.entries.create({
  name: "Getting started",
  collectionID: "coll_example"
});

Response

json

{
  "id": "string",
  "name": "string",
  "order": "string",
  "collectionID": "string",
  "path": "string",
  "slugPath": "string"
}

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "IDEMPOTENCY_KEY_REUSED",
  "status": 422,
  "message": "This Idempotency-Key was used with a different request",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}