Skip to content
vocapable.Docs

Guide

GET
/v1/developer/documentation/guides/{guide_id}
curl --request GET \
  --url https://api.vocapable.com/v1/developer/documentation/guides/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
guide_id
required
Guide Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DocumentationGuide
object
id
required
Id
string
title
required
Title
string
description
required
Description
string
steps
required
Steps
Array<object>
DocumentationStep
object
title
required
Title
string
text
required
Text
string
code
Any of:
string
operations
Operations
Array<string>
Examplegenerated
{
  "id": "example",
  "title": "example",
  "description": "example",
  "steps": [
    {
      "title": "example",
      "text": "example",
      "code": "example",
      "operations": [
        "example"
      ]
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}