JKring/docs.md

## docs.md

      
    Raw
  

              docs.md
            
          
    Scripted.com API V1

tldr; create a job for Scripted.com writers!
 API Endpoint

https://api.scripted.com


Authentication
HTTP Status Code Summary
API Data Types
Scripted.com Data Model
Use Case
Resource URL Patterns
Methods

Authentication

Authentication to the Scripted.com API occurs via HTTP Basic Auth over SSL.
Provide your API key as the basic auth username. You do not need to provide a password.
Example

curl https://api.scripted.com/v1/industries \
 -u scrpt_test_21db27a5c1c20f89c498c:

HTTP Status Code Summary


200 OK Everything worked as expected.
400 Bad Request Often missing a required parameter.
401 Unauthorized No valid API key provided.
402 Request Failed Parameters were valid but request failed.
404 Not Found The requested item doesn't exist.
500, 502, 503, 504 Server errors Something went wrong on Scripted's end.

API Data Types


boolean
The value is either true or false. In JSON-encoded requests and responses, a boolean value is represented with the bare symbols true and false. Attributes that are boolean are never "empty," so they will not be dropped from server responses like other attributes can be.
string
This type of value is a string of text characters. Most string-type parameters have a maximum character count. The length limit is represented in the Resources reference by a number, enclosed in square brackets, added to the end of the type name. For example, string[120] indicates a string with a maximum length of 120 characters. In JSON-encoded requests and responses, strings must be enclosed in quotation marks and employ conventional JSON (JavaScript) character escaping and encoding.
int
An integer value. Integers are decimal, and some may be zero and/or negative. Most integer parameters/attributes must be 1 or larger. The requirements for a particular integer value should be clear from context, and the API will return error messages if not.
datetime
A representation of a particular date and time in the UTC timezone using the ISO-8601 format
object
This indicates that the value is an un-type-checked nested hash data structure.
For both request parameters and response attributes listed as being object type,
their expected/possible content should be clear from context.

Scripted.com Data Model

Job

Jobs are the core of the Scripted.com API and connect buyers with our talented writers.
Job Template

A job template has a content format, such as a Short Blog Post, and a collection of
prompts to that are designed to help guide your writer.
Content Format

The format that your writer should follow, for example, blog post, whitepaper, or tweet.
Prompts

Prompts are question/answer pairs that help guide your writer.
Industries

The industries your writer should understand. For example, "Lifestyle/Travel".
Optionally you specify that you require an industry expert.
Guidelines

The guidelines your writer should follow, for example, "Instructional/Educational"
 Use Case

Mary McSmarty would like to include a form on her website that allows customers
to purchase high-quality content from Scripted.com. Mary's customers will be
able to select a topic, a content format, such as a blog post, and provide
answers to pre-defined prompts such as "Things to mention".
Selecting a Job Template

The Scripted.com API provides a collection of default job templates to help
get you started.  A job template has a content format, and a collection of
prompts that are designed to help guide your writer.
List available Job Templates

$ curl https://api.scripted.com/v1/job_templates?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "52cdda648b588f7e020034d5",
    "content_format": {
      "id": "52cdda648b588f7e020034d5",
      "name": "Standard Blog Post",
      "price": 49.0,
      "min_count": 1,
      "pitchable": true,
      "length_metric": "350-450 words"
    },
    "prompts": [
      {
        "id": "52cdda2f8b588f7e02000062",
        "type": "boolean",
        "label": "This post should mention Battletoads",
        "value": true
      },
      {
        "id": "52cdda2f8b588f7e02000064",
        "type": "string[255]",
        "label": "What hash tags should the writer mention?"
      }
    ]
  }
]

Creating a Job

Jobs are created for our writers by submitting a job template and answers to prompts.
Optionally a list of guidelines and industries may be submitted.
Example request


$ curl https://api.scripted.com/v1/jobs \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d topic="Why a rug can tie a room together"  \
  -d job_template[id]=5ceb8bb8235bcc76bf475e21 \
  -d job_template[prompts][][id]=52cdda2f8b588f7e02000062 \
  -d job_template[prompts][][value]=true \
  -d job_template[prompts][][id]=52cdda2f8b588f7e02000064 \
  -d job_template[prompts][][value]=#yolo \
  -d guidelines[][id]=e9d378cc8e74b4b5faa34892935d5665 \
  -d guidelines[][id]=689ca0246221f2f21e80e9dac9387bce \
  -d industries[][id]=8af7c7ae67b6d0854051378b9f3eede4 \
  -d industries[][id]=92e4132ea0560de3c12f072dc9a81486 \
  -d industries[][id]=f0709aabc7050b3eed7c43db83f0f4cf

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "writing",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?",
      "value": "#yolo"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

 Summary of Resource URL patterns


/v1/jobs/
/v1/jobs/{JOB_ID}
/v1/job_templates/
/v1/job_templates/{JOB_TEMPLATE_ID}/
/v1/content_formats/
/v1/content_formats/{FORMAT_ID}
/v1/prompts/
/v1/prompts/{PROMPT_ID}
/v1/industries/
/v1/industries/{INDUSTRY_ID}
/v1/guidelines/
/v1/guidelines/{GUIDELINE_ID}
/v1/check_spelling

Methods


Jobs
Create a new job
Retrieve an existing job
Accept an existing job
Request edits on an existing job
Reject an existing job
[Update a job]
List all jobs
Job Templates
Retrieving an existing job template
List all job templates
Content Formats
List all content formats
Retrieving an existing content format
Prompts
Retrieving an existing prompt
Update a prompt
List all prompts
Industries
List all industries
Retrieving an existing industry
Guidelines
Retrieving an existing guideline
List all guidelines
Spell Checker

Jobs

Jobs are the core of the Scripted.com API and connect buyers with our talented writers.
The job object

Attributes


id: string[24]
business: object, business
topic: string[255]
count: positive integer
state: string[255]
delivery: string, ["rush", "standard"]
details: string[255]
created_at: datetime
deadline_at: datetime
content_format: object content_format
prompts: list, prompt object
guidelines: list, guideline object
industries: list, industry object

Example object

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "writing",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Create a job

Definition

POST https://api.scripted.com/v1/jobs  

Parameters


topic string[255]
count positive integer
job_template object job_template
id *string[24]`
prompts list, prompts

id: string[24]
value string[1024]


delivery: string, ["rush", "standard"]
guidelines list, guidelines

id: string[24]


industries list, industries

id: string[24]


Example request with job template

$ curl https://api.scripted.com/v1/jobs \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d topic="Why a rug can tie a room together"  \
  -d job_template[id]=5ceb8bb8235bcc76bf475e21 \
  -d job_template[prompts][][id]=52cdda2f8b588f7e02000062 \
  -d job_template[prompts][][value]=true \
  -d job_template[prompts][][id]=52cdda2f8b588f7e02000064 \
  -d job_template[prompts][][value]=#yolo \
  -d guidelines[][id]=e9d378cc8e74b4b5faa34892935d5665 \
  -d guidelines[][id]=689ca0246221f2f21e80e9dac9387bce \
  -d industries[][id]=8af7c7ae67b6d0854051378b9f3eede4 \
  -d industries[][id]=92e4132ea0560de3c12f072dc9a81486 \
  -d industries[][id]=f0709aabc7050b3eed7c43db83f0f4cf

Response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "writing",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Retrieving an existing job

Definition

GET https://api.scripted.com/v1/jobs/{JOB_ID}

Parameters


{JOB_ID} string[24]

Example request

$ curl https://api.scripted.com/v1/jobs/96109a19b2e8082834d52eca \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "writing",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Accept an existing job

Definition

POST https://api.scripted.com/v1/jobs/{ID}/accept

Parameters


{ID} string[24]

Requirements

Only jobs in the ready for acceptance or the ready for review state can be accepted.
Example request

$ curl https://api.scripted.com/v1/jobs/96109a19b2e8082834d52eca/accept \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d id=96109a19b2e8082834d52eca

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "accepted",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Request Edits on an existing job

Definition

POST https://api.scripted.com/v1/jobs/{ID}/request_edits

Parameters


{ID} string[24]

Requirements

Only jobs in the ready for review state allow edits to be requested.
Example request

$ curl https://api.scripted.com/v1/jobs/96109a19b2e8082834d52eca/request_edits \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d id=96109a19b2e8082834d52eca

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "revising",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Reject an existing job

Definition

POST https://api.scripted.com/v1/jobs/{ID}/reject

Parameters


{ID} string[24]

Requirements

Only jobs in the ready for acceptance state can be rejected.
Example request

$ curl https://api.scripted.com/v1/jobs/96109a19b2e8082834d52eca/reject \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d id=96109a19b2e8082834d52eca

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "rejected",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

Update an existing job

Definition

POST https://api.scripted.com/v1/jobs/{JOB_ID}

Parameters


{JOB_ID} string[24]
topic string[255]
count positive integer
prompts list, prompts

id: string[24]
value string[1024]


delivery: string, ["rush", "standard"]
guidelines list, guidelines

id: string[24]


industries list, industries

id: string[24]


Example request

$ curl https://api.scripted.com/v1/jobs \
  -u scrpt_test_21db27a5c1c20f89c498c: \
  -d topic="Speed of Sound Tour"

Example response

{
  "id": "96109a19b2e8082834d52eca",
  "business": {
    "id": "52cdda618b588f7e020033c7"
  },
  "count": "1",
  "state": "writing",
  "topic": "Why a rug can tie a room together",
  "delivery": "standard",
  "created_at": "2014-01-08T23:08:20Z",
  "deadline_at": "2014-01-16T01:30:00Z",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads",
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064",
      "type": "string[255]",
      "label": "What hash tags should the writer mention?"
    }
  ],
  "industries": [
    {
      "id": "52cdda2f8b588f7e020000e8",
      "name": "Fashion"
    },
    {
      "id": "52cdda2f8b588f7e020000a2",
      "name": "Clothing"
    }
  ],
  "guidelines": [
    {
      "id": "52cdda2f8b588f7e02000059",
      "kind": "Tone",
      "name": "Formal/Professional"
    },
    {
      "id": "52cdda2f8b588f7e0200005a",
      "kind": "Audience",
      "name": "Seniors"
    }
  ]
}

 List all jobs

Definition

GET https://api.scripted.com/v1/jobs/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/jobs?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "96109a19b2e8082834d52eca",
    "business": {
      "id": "52cdda618b588f7e020033c7"
    },
    "count": "1",
    "state": "writing",
    "topic": "Why a rug can tie a room together",
    "delivery": "standard",
    "created_at": "2014-01-08T23:08:20Z",
    "deadline_at": "2014-01-16T01:30:00Z",
    "content_format": {
      "id": "52cdda2f8b588f7e02000031",
      "name": "Standard Blog Post",
      "price": 49.0,
      "min_count": 1,
      "pitchable": true,
      "length_metric": "350-450 words"
    },
    "prompts": [
      {
        "id": "52cdda2f8b588f7e02000062",
        "type": "boolean",
        "label": "This post should mention Battletoads",
        "value": true
      },
      {
        "id": "52cdda2f8b588f7e02000064",
        "type": "string[255]",
        "label": "What hash tags should the writer mention?"
      }
    ],
    "industries": [
      {
        "id": "52cdda2f8b588f7e020000e8",
        "name": "Fashion"
      },
      {
        "id": "52cdda2f8b588f7e020000a2",
        "name": "Clothing"
      }
    ],
    "guidelines": [
      {
        "id": "52cdda2f8b588f7e02000059",
        "kind": "Tone",
        "name": "Formal/Professional"
      },
      {
        "id": "52cdda2f8b588f7e0200005a",
        "kind": "Audience",
        "name": "Seniors"
      }
    ]
  }
]

States

Jobs can be returned with any of the following values for state:
 * hold
 * awaiting author
 * writing
 * copyediting
 * ready for review
 * revising
 * ready for acceptance
 * accepted
 * canceled
 * rejected

In the sandbox, at least one job will be returned for each state.
Job Templates

A job template has a content format, such as a Short Blog Post,
and a collection of prompts to that are designed to help guide your writer.
The job_template object

Attributes


id: string[24]
content_format: object content_format
prompts: list, prompt

Example object

{
  "id": "5ceb8bb8235bcc76bf475e21",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads"
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064"
    "type": "string[255]",
    "label": "What hash tags should the writer mention?"
    }
  ]
}

Retrieving an existing job template

Definition

GET https://api.scripted.com/v1/job_templates/{JOB_TEMPLATE_ID}

Parameters


{JOB_TEMPLATE_ID} string[24]

Example request

$ curl https://api.scripted.com/v1/job_templates/5ceb8bb8235bcc76bf475e21 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "5ceb8bb8235bcc76bf475e21",
  "content_format": {
    "id": "52cdda2f8b588f7e02000031"
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  },
  "prompts": [
    {
      "id": "52cdda2f8b588f7e02000062",
      "type": "boolean",
      "label": "This post should mention Battletoads"
      "value": true
    },
    {
      "id": "52cdda2f8b588f7e02000064"
    "type": "string[255]",
    "label": "What hash tags should the writer mention?"
    }
  ]
}


List all Job Templates

Definition

GET https://api.scripted.com/v1/job_templates/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/job_templates?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "52cdda648b588f7e020034d5",
    "content_format": {
      "id": "52cdda648b588f7e020034d5",
      "name": "Standard Blog Post",
      "price": 49.0,
      "min_count": 1,
      "pitchable": true,
      "length_metric": "350-450 words"
    },
    "prompts": [
      {
        "id": "52cdda2f8b588f7e02000062",
        "type": "boolean",
        "label": "This post should mention Battletoads",
        "value": true
      },
      {
        "id": "52cdda2f8b588f7e02000064",
        "type": "string[255]",
        "label": "What hash tags should the writer mention?"
      }
    ]
  }
]

Content Format

The format that your writer should follow, for example, blog post, whitepaper, or tweet.
The content_format object

Attributes


id: string[24]
name: string[255]
price: positive integer or zero
min_count: positive integer or zero
length_metric: string[255]

Example object

{
  "id": "9213434540adc96a90a75a2c"
  "name": "Standard Blog Post",
  "price": 49.0,
  "min_count": 1,
  "pitchable": true,
  "length_metric": "350-450 words"
}

List all content_formats

Definition

GET https://api.scripted.com/v1/content_formats/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/content_formats?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "9213434540adc96a90a75a2c",
    "name": "Standard Blog Post",
    "price": 49.0,
    "min_count": 1,
    "pitchable": true,
    "length_metric": "350-450 words"
  }
]

Retrieving an existing content_format

Definition

GET https://api.scripted.com/v1/content_formats/{CONTENT_FORMAT_ID}

Parameters


{FORMAT_ID}
ID of content_format to retrieve.

Example request

$ curl https://api.scripted.com/v1/content_formats/52cdda2f8b588f7e02000062 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "52cdda648b588f7e020034d5",
  "name": "Standard Blog Post",
  "price": 49.0,
  "min_count": 1,
  "pitchable": true,
  "length_metric": "350-450 words"
}

Prompts

Prompts are question/answer pairs that help guide your writer.
The prompt object

Attributes


id: string[24]
type: [boolean, string[255], check_boxes, radio_buttons]
label: string[255]
value: string[255], optional

Example object

{
  "id": "a85a11d27da7dfcce25d8a62",
  "type": "boolean",
  "label": "This post should mention Battletoads",
  "value": true
}

Retrieving an existing prompt

Definition

GET https://api.scripted.com/v1/prompts/{id}

Parameters


{id} string[24]

Example request

$ curl https://api.scripted.com/v1/prompts/a85a11d27da7dfcce25d8a62 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "a85a11d27da7dfcce25d8a62",
  "type": "string",
  "label": "Hash tags to mention",
  "value": "#yolo"
}

List all prompts

Definition

GET https://api.scripted.com/v1/prompts/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/prompts?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "prompts": [{
    "id": "a85a11d27da7dfcce25d8a62",
    "type": "string",
    "label": "Hash tags to mention",
    "value": "#yolo",
  }
}

Guidelines

The guidelines your writer should follow, for example, "Instructional/Educational"
The guideline object

Attributes


id: string[24]
kind: string, ["Tone", "Voice", "Audience"]
name: string[128]

Example object

{
  "id": "369dbe62f57c3e876e192f36",
  "kind": "Tone",
  "name": "Instructional/Educational"
}

Retrieving an existing guideline

Definition

GET https://api.scripted.com/v1/guidelines/{GUIDELINE_ID}

Parameters


{GUIDELINE_ID}

Example request

$ curl https://api.scripted.com/v1/guidelines/369dbe62f57c3e876e192f36 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "369dbe62f57c3e876e192f36",
  "kind": "Tone",
  "name": "Instructional/Educational"
}

List all guidelines

Definition

GET https://api.scripted.com/v1/guidelines/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/guidelines?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "369dbe62f57c3e876e192f36",
    "kind": "Tone",
    "name": "Instructional/Educational"
  }
]

Industries

The industries your writer should understand. For example, "Lifestyle/Travel".
The industry object

Attributes


id: string[24]
name: string[128]

Example object

{
  "id": "72e7a1c3e7a827478e523408",
  "name": "Lifestyle/Travel"
}

Retrieving an existing industry

Definition

GET https://api.scripted.com/v1/industries/{INDUSTRY_ID}

Parameters


{INDUSTRY_ID} string[24]

Example request

$ curl https://api.scripted.com/v1/industries/72e7a1c3e7a827478e523408 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

{
  "id": "72e7a1c3e7a827478e523408",
  "name": "Lifestyle/Travel"
}

List all industries

Definition

GET https://api.scripted.com/v1/industries/

Parameters


count optional
Limit on the number of objects to be returned. Count can range between 1 and 100 items.

Example request

$ curl https://api.scripted.com/v1/industries?count=1 \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example response

[
  {
    "id": "72e7a1c3e7a827478e523408",
    "name": "Lifestyle/Travel"
  }
]

Spell Checker

The spell checker accepts a string a query parameter and returns spelling errors
Definition

GET https://api.scripted.com/v1/check_spelling

Parameters


q string[1000]

The spelling_error object

Attributes


word: string[255]
suggestions: list, string[255]

Example request

$ curl https://api.scripted.com/v1/check_spelling?q=beautifull+skies+are+herz+today \
  -u scrpt_test_21db27a5c1c20f89c498c:

Example Response

[
  {
    "word": "beautifull",
    "suggestions": [
      "beautiful",
      "beautifully"
    ]
  },
  {
    "word": "herz",
    "suggestions": [
      "here",
      "her",
      "hers",
      "herd",
      "hertz"
    ]
  }
]
No results found