Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowth

Interview routes

Every Interview Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Interview.

NounSystemRun by
InterviewDiscoveryResearcher

Interview.create

Creates an Interview. Verb page.

Text
POST /{namespace}/interviews

Body, as JSON: the inputs. Emits Interview.created.

Inputs

InputTypeRequiredDescription
subjectstringWhat the Thread is about.
scriptTemplaterequiredThe questions asked.
transcripttextWhat was said.

Returns

OutputTypeRequiredDescription
interviewInterviewrequiredThe Interview.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/interviews \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"script":"template_THRQF1h9uX"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "interview": {
    "$id": "https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5",
    "$type": "Interview",
    "script": "template_THRQF1h9uX"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Interview.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Interview.get

Returns one Interview by id. Verb page.

Text
GET /{namespace}/interviews/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Interview.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
interviewInterviewrequiredThe Interview.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Interview",
  "$id": "https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5",
  "interview": {
    "$id": "https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5",
    "$type": "Interview",
    "script": "template_THRQF1h9uX"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5",
    "up": "https://api.sb/leaseline.app/interviews"
  }
}

Interview.list

Returns Interviews, newest first, one page at a time. Verb page.

Text
GET /{namespace}/interviews

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
interviewslist of InterviewrequiredOne page of Interviews.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/interviews?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Interview",
  "interviews": [
    {
      "$id": "https://api.sb/leaseline.app/interviews/interview_DZxhK36mF5",
      "$type": "Interview",
      "script": "template_THRQF1h9uX"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "interview_DZxhK36mF5"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/interviews?limit=20",
    "next": "https://api.sb/leaseline.app/interviews?after=interview_DZxhK36mF5"
  }
}

update, delete

Previous

Key Result

Next