Skip to main content
POST
/
language
/
edit
Edit
curl --request POST \
  --url https://test.api.cxconnect.ai/language/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": {
    "value": "<string>",
    "mime_type": "<string>",
    "language": "<string>",
    "meta": {}
  },
  "edits": [
    "grammar"
  ],
  "length": "default",
  "tone": "none",
  "tone_level": 5,
  "temperature": 0.5,
  "meta": {
    "foo": "bar"
  }
}'
{
  "document": {
    "value": "<string>",
    "mime_type": "<string>",
    "language": "<string>",
    "meta": {}
  },
  "original": {
    "value": "<string>",
    "mime_type": "<string>",
    "language": "<string>",
    "meta": {}
  },
  "meta": {
    "foo": "bar"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
document
object
edits
enum<string>[]
length
enum<string>
Available options:
default,
expand,
shorten
tone
enum<string>
Available options:
none,
academic,
admiring,
amused,
angry,
annoyed,
approving,
aware,
confident,
confused,
curious,
disappointed,
disapproving,
eager,
embarrassed,
excited,
fearful,
friendly,
funny,
grateful,
joyful,
loving,
mournful,
neutral,
optimistic,
professional,
relieved,
remorseful,
repulsed,
sad,
worried,
surprised,
sympathetic
tone_level
integer
Required range: 1 <= x <= 10
temperature
number
Required range: 0 <= x <= 1
meta
object
Example:
{ "foo": "bar" }

Response

Successful edit response

document
object
original
object
meta
object
Example:
{ "foo": "bar" }
I