POST
/
search
curl --request POST \
  --url https://api.lume.ai/search \
  --header 'Content-Type: application/json' \
  --header 'lume-api-key: <api-key>' \
  --data '{
  "model": "user",
  "params": {}
}'
{
  "items": [
    "<any>"
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Gets an object in bulk via a filter.

python example
response = requests.post(
    f"{url}/search",
    headers={
        'lume-api-key': '<api-key>'
    },
    json={
        'model': 'pipeline',
        'params': {
            'name': 'ordered'
        }
    }
)

Authorizations

lume-api-key
string
headerrequired

Query Parameters

page
integer
default: 1

Page number

size
integer
default: 50

Page size

Body

application/json
model
enum<string>
required

The model you want to search

Available options:
user,
pipeline,
job,
workshop,
result,
mapping
params
object | null

The parameters you want to search by. For non-id fields, the search returns results that contain the search term.

Response

200 - application/json
items
any[]
required
total
integer | null
required
page
integer | null
required
size
integer | null
required
pages
integer | null