SDK (Coming Soon)

This page is coming soon

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time.

Install the library

The best way to interact with our API is to use one of our official libraries:

Node

# Install via NPM
npm install --save my-api

Python

# Install via pip
pip install --upgrade myapi

Make your first request

To make your first request, send an authenticated request to the pets endpoint. This will create a job, which is nice.

Create Job.

POST https://api.myapi.com/v1/job

Creates a new pet.

Request Body

Name	Type	Description
name*	string	The name of the pet
owner_id	string	The id of the user who owns the pet
species	string	The species of the pet
breed	string	The breed of the pet

200 Pet successfully created

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

401 Permission denied

Good to know: You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.myapi.com/v1/job  
    -u YOUR_API_KEY:  
    -d name='...'
    -d org_id='sha7891bikojbkreuy'  

Node

// require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);

const newPet = away myapi.pet.create({
    name: 'Wilson',
    owner_id: 'sha7891bikojbkreuy',
    species: 'Dog',
    breed: 'Golden Retriever',
})

Python

// Set your API key before making the request
myapi.api_key = YOUR_API_KEY

myapi.Pet.create(
    name='Wilson',
    owner_id='sha7891bikojbkreuy',
    species='Dog',
    breed='Golden Retriever',
)