The Aryeo API provides access to the Aryeo platform.

Languages
Servers
Mock server

https://docs.aryeo.com/_mock/api/aryeo/

Production

https://api.aryeo.com/v1/

Addresses

Operations related to addresses.

Operations

Appointments

Operations related to appointments.

Operations

Discounts

Operations related to discounts.

Operations

Listings

Operations related to listings.

Operations

Notes

Operations related to notes.

Operations

Order Forms

Operations related to order forms.

Operations

Order Items

Operations related to order items.

Operations

Orders

Operations related to orders.

Operations

Payroll

Operations related to payroll.

Operations

Products

Operations related to products.

Operations

Scheduling

Operations related to scheduling.

Operations

Tags

Operations related to tags.

Operations

Tasks

Operations related to tasks.

Operations

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations

Get video.

Request

Get video.

external: true
Path
video_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a video. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const videoId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/videos/${videoId}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

OK

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Video)

A recording of moving visual images. Provided either as a download URL (MP4) or a link (e.g. YouTube, Vimeo).

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{ "status": "success", "data": { "object": "VIDEO", "id": "00000000-0000-4000-8000-000000000000", "title": "The New Vimeo Player (You Know, For Videos)", "duration": 360, "display_type": "BRANDED", "source_type": "OPTIMIZED", "thumbnail_url": "https://picsum.photos/300", "playback_url": "https://player.vimeo.com/video/76979871", "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4", "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1" }, "timestamp": "2021-06-30T20:30:00Z" }

Update video.

Request

Update video.

external: true
Path
video_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a video. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Bodyapplication/json
titlestring[ 1 .. 100 ] charactersrequired

The name of the video.

Example: "Home Walkthrough Video"
const videoId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/videos/${videoId}`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      title: 'Home Walkthrough Video'
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

OK

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Video)

A recording of moving visual images. Provided either as a download URL (MP4) or a link (e.g. YouTube, Vimeo).

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{ "status": "success", "data": { "object": "VIDEO", "id": "00000000-0000-4000-8000-000000000000", "title": "The New Vimeo Player (You Know, For Videos)", "duration": 360, "display_type": "BRANDED", "source_type": "OPTIMIZED", "thumbnail_url": "https://picsum.photos/300", "playback_url": "https://player.vimeo.com/video/76979871", "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4", "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1" }, "timestamp": "2021-06-30T20:30:00Z" }

Delete video.

Request

Delete video.

external: true
Path
video_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a video. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const videoId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/videos/${videoId}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

if (resp.status === 204) {
  console.log('success');
} else {
  const data = await resp.text();
  console.log(data);
}

Responses

No Content

Response
No content