Search - Moonshine Docs

cURL

curl --request GET \
  --url https://api.usemoonshine.com/search

{
  "status": "complete",
  "output": {}
}

GET

/

search

cURL

curl --request GET \
  --url https://api.usemoonshine.com/search

{
  "status": "complete",
  "output": {}
}

Query Parameters

token

string

required

User authentication token

index

string

required

name of the media index

query

string

required

Search query string

numargs

integer

default:5

Number of results to return

Required range: x >= 1

threshold

integer

default:1000

Search threshold value

Required range: x >= 0

Response

Search results

status

enum<string>

Status of the search operation

Available options:

complete,

project may stil be processing

output

object

Search results object

Show child attributes

output.{key}

object

Show child attributes

output.{key}.embeddings

object[]

Array of embedding matches

Show child attributes

output.{key}.embeddings.fileID

string

Moonshine assigned video fileID name

output.{key}.embeddings.frameStart

integer

Starting frame number of match

output.{key}.embeddings.frameEnd

integer

Ending frame number of match

output.{key}.embeddings.timestampStart

string

Human readable start timestamp

output.{key}.embeddings.timestampEnd

string

Human readable end timestamp

output.{key}.transcript

object[]

Array of transcript matches

Show child attributes

output.{key}.transcript.fileID

string

Moonshine assigned video fileID name

output.{key}.transcript.frameStart

integer

Starting frame number of match

output.{key}.transcript.frameEnd

integer

Ending frame number of match

output.{key}.transcript.timestampStart

string

Human readable start timestamp

output.{key}.transcript.timestampEnd

string

Human readable end timestamp

output.{key}.ocr

object[]

Array of OCR text matches

Show child attributes

output.{key}.ocr.fileID

string

Moonshine assigned video fileID name

output.{key}.ocr.frameStart

integer

Starting frame number of match

output.{key}.ocr.frameEnd

integer

Ending frame number of match

output.{key}.ocr.timestampStart

string

Human readable start timestamp

output.{key}.ocr.timestampEnd

string

Human readable end timestamp

⌘I