{"openapi":"3.1.0","info":{"title":"Harvard Dataverse (BYOK) API","version":"0.1.0","description":"Harvard Dataverse (BYOK) lets an AI assistant read your own Harvard Dataverse data through the Harvard Dataverse API with a key you supply (Harvard Dataverse API token (Account > API Token)). Read-only: 7 tools (search, get_collection, list_collection_contents, list_dataset_versions, list_dataset_files, get_dataset_citation, get_server_version). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-harvard-dataverse.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-harvard-dataverse/docs"},"termsOfService":"https://connectorbay.com/byok-harvard-dataverse/terms"},"servers":[{"url":"https://byok-harvard-dataverse.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-harvard-dataverse/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search":{"post":{"operationId":"search","summary":"Search Harvard Dataverse collections, datasets and files by text; returns the total count and matching items with name, ","description":"Search Harvard Dataverse collections, datasets and files by text; returns the total count and matching items with name, type, URL, identifier, description, citation and subjects. Use for \"Find datasets about wildfire smoke in Harvard Dataverse\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"description":"Search text. 'title:data' searches only the title field; * works as a wildcard next to a term.","maxLength":300,"title":"Q","type":"string"},"type":{"anyOf":[{"enum":["dataverse","dataset","file"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this kind of result: dataverse, dataset or file.","title":"Type"},"subtree":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Alias of a collection to search inside (including its sub-collections).","title":"Subtree"},"sort":{"anyOf":[{"enum":["name","date","score"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: name, date or score (relevance, default).","title":"Sort"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc or desc, used with sort.","title":"Order"},"per_page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 1000).","title":"Per Page"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Offset of the first result, for paging.","title":"Start"}},"required":["q"],"title":"searchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_collection":{"post":{"operationId":"get_collection","summary":"Get a Dataverse collection by alias or id: name, alias, description, affiliation and creation date. Use for \"What is the","description":"Get a Dataverse collection by alias or id: name, alias, description, affiliation and creation date. Use for \"What is the Harvard Dataverse collection 'harvard' about\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection":{"description":"Collection alias, numeric id, or ':root' for the root collection, for example 'harvard'.","maxLength":100,"title":"Collection","type":"string"}},"required":["collection"],"title":"get_collectionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_collection_contents":{"post":{"operationId":"list_collection_contents","summary":"List the collections and datasets directly under one collection (published ones, plus unpublished ones the token can acc","description":"List the collections and datasets directly under one collection (published ones, plus unpublished ones the token can access). Use for \"What is directly inside the Harvard Dataverse collection 'harvard'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection":{"description":"Collection alias, numeric id, or ':root' for the root collection, for example 'harvard'.","maxLength":100,"title":"Collection","type":"string"}},"required":["collection"],"title":"list_collection_contentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dataset_versions":{"post":{"operationId":"list_dataset_versions","summary":"List the versions of a dataset with version number, state, license and release dates (files and metadata blocks are left","description":"List the versions of a dataset with version number, state, license and release dates (files and metadata blocks are left out). Use for \"How many versions does dataset doi:10.7910/DVN/TJCLKP have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"persistent_id":{"description":"Persistent identifier of the dataset including the scheme, for example 'doi:10.7910/DVN/TJCLKP'.","maxLength":200,"title":"Persistent Id","type":"string"},"exclude_files":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to leave the file lists out (recommended).","title":"Exclude Files"},"exclude_metadata_blocks":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to leave the metadata blocks out (recommended).","title":"Exclude Metadata Blocks"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many entries to return.","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many entries to skip, for paging.","title":"Offset"}},"required":["persistent_id"],"title":"list_dataset_versionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dataset_files":{"post":{"operationId":"list_dataset_files","summary":"List the files of one dataset version with file names, sizes, types and access settings; supports paging and text, conte","description":"List the files of one dataset version with file names, sizes, types and access settings; supports paging and text, content type or access filters. Use for \"Which files are in dataset doi:10.7910/DVN/TJCLKP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"version":{"description":"Dataset version: ':latest', ':latest-published', ':draft' (needs access) or a number such as '1.0'.","maxLength":40,"title":"Version","type":"string"},"persistent_id":{"description":"Persistent identifier of the dataset including the scheme, for example 'doi:10.7910/DVN/TJCLKP'.","maxLength":200,"title":"Persistent Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many entries to return.","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many entries to skip, for paging.","title":"Offset"},"search_text":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only files whose label or description contains this text.","title":"Search Text"},"content_type":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only files of this MIME type, for example 'text/csv'.","title":"Content Type"},"category_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only files with this category, for example 'Data'.","title":"Category Name"}},"required":["version","persistent_id"],"title":"list_dataset_filesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_dataset_citation":{"post":{"operationId":"get_dataset_citation","summary":"Get the formatted citation text of one dataset version as shown on its Harvard Dataverse page. Use for \"Give me the cita","description":"Get the formatted citation text of one dataset version as shown on its Harvard Dataverse page. Use for \"Give me the citation for doi:10.7910/DVN/TJCLKP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"version":{"description":"Dataset version: ':latest', ':latest-published', ':draft' (needs access) or a number such as '1.0'.","maxLength":40,"title":"Version","type":"string"},"persistent_id":{"description":"Persistent identifier of the dataset including the scheme, for example 'doi:10.7910/DVN/TJCLKP'.","maxLength":200,"title":"Persistent Id","type":"string"},"include_deaccessioned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also consider deaccessioned versions.","title":"Include Deaccessioned"}},"required":["version","persistent_id"],"title":"get_dataset_citationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_server_version":{"post":{"operationId":"get_server_version","summary":"Show the Dataverse software version and build of Harvard Dataverse. Use for \"Which Dataverse software version does Harva","description":"Show the Dataverse software version and build of Harvard Dataverse. Use for \"Which Dataverse software version does Harvard Dataverse run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_server_versionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}