Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: PopSQL Query Runs API
version: 1.2.0
servers:
- url: https://api.popsql.com/v1
tags:
- name: Query Runs
paths:
/queries/{query_id}/runs:
post:
summary: Run a query
tags:
- Query Runs
description: '- You must own or have permissions to the query to run it.
- Enforces a 10 second query timeout limit.'
parameters:
- in: path
name: query_id
schema:
type: string
required: true
example: -N1LP3WvU0UwEWR9_oL_
description: 'You can find the query''s ID by navigating to the query in the PopSQL app, opening the share modal, and copying the share link. The link will look like: `https://app.popsql.com/queries/<query_id>/<query name>`'
requestBody:
description: If your query uses variables, you can pass them as key-value pairs in a JSON object as the `variables` field in the request body.
content:
application/json:
schema:
type: object
properties:
variables:
type: object
description: Key-value pairs of variable names and values.
additionalProperties: true
example:
your_variable_name: your_variable_value
examples:
basic:
summary: An example using variables
value:
variables:
your_variable_name: your_variable_value
security:
- bearerAuth: []
responses:
'200':
description: Successful Run
content:
application/json:
example:
error: null
fields:
- name: id
- name: name
- name: country_code
- name: district
- name: population
row_count: 1
rows:
- id: 1
name: Kabul
country_code: AFG
district: Kabol
population: 1780000
operationId: postQueriesByQueryIdRuns
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
x-provenance:
method: searched
source: https://docs.popsql.com/reference
harvested: '2026-10-29'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.popsql.com/reference/get_connections-connection-id-catalog-columns.md
- https://docs.popsql.com/reference/get_connections-connection-id-catalog-tables.md
- https://docs.popsql.com/reference/get_connections-connection-id-catalog.md
- https://docs.popsql.com/reference/get_connections-connection-id-databases-database-name-catalog.md
- https://docs.popsql.com/reference/get_connections-connection-id-databases-database-name-schemas-schema-name-catalog.md
- https://docs.popsql.com/reference/get_connections-connection-id-databases-database-name-schemas-schema-name-tables-table-name-catalog.md
- https://docs.popsql.com/reference/get_connections-connection-id-databases-database-name-schemas-schema-name-tables-table-name-columns-column-name-catalog.md
- https://docs.popsql.com/reference/patch_connections-connection-id-catalog.md
- https://docs.popsql.com/reference/patch_connections-connection-id-databases-database-name-catalog.md
- https://docs.popsql.com/reference/patch_connections-connection-id-databases-database-name-schemas-schema-name-catalog.md
- https://docs.popsql.com/reference/patch_connections-connection-id-databases-database-name-schemas-schema-name-tables-table-name-catalog.md
- https://docs.popsql.com/reference/patch_connections-connection-id-databases-database-name-schemas-schema-name-tables-table-name-columns-column-name-catalog.md
- https://docs.popsql.com/reference/post_queries-query-id-runs.md
merge:
pages: 13
deduped: 51
conflicts_kept_first: 0