PapersWithCode TLDR
PapersWithCode TLDR · Ações GPT
PapersWithCode API
PapersWithCode API Documentation ans Schema.
GET /areas/List all task Areas.Return a paginated listing of all task ares..
GET /areas/{area}/Get an Area.Return a selected area by its id.
GET /areas/{area}/tasks/List all task in a an area.Return a paginated listing of task in a selected area.
GET /authors/List all paper authors.Return a paginated list of paper authors.
GET /authors/{author}/papers/List all papers connected to the author.Return all papers connected to the author.
GET /datasets/List all Datasets.Return a paginated listing of all datasets.
GET /datasets/{dataset}/Get a Dataset.Return a specific dataset selected by its id.
GET /datasets/{dataset}/evaluations/List all Evaluation Tables for a Dataset.Return a list of all SOTA (evaluation tables) for a selected dataset.
GET /evaluations/List all Evaluation Tables.Return a paginated listing of all evaluation tables.
GET /evaluations/{evaluation}/Get an evaluation table.Return a specific evaluation table selected by its id.
GET /evaluations/{evaluation}/metrics/Get evaluation table metric.Return a specific evaluation table metric.
GET /evaluations/{evaluation}/results/Get evaluation table results.Return a specific evaluation table results.
GET /methods/List all Methods.Return a paginated listing of all methods.
GET /methods/{method}/Get a Method.Return a specific method selected by it's id.
GET /papers/List all Papers.Return a paginated listing of all papers.
GET /papers/{paper}/Get a Paper.Return a specific papers selected by its id.
GET /papers/{paper}/datasets/List all datasets mentioned in the paper.Return all datasets mentioned in the paper.
GET /papers/{paper}/methods/List all methods discussed in the paper.Return all methods mentioned in the paper.
GET /papers/{paper}/repositories/List all repositories that implement a paper.Return all implementations of a selected paper.
GET /papers/{paper}/results/List all evaluation results for the paper.Return all evaluation results for the paper.
GET /papers/{paper}/tasks/List all tasks discussed in the paper.Return all tasks mentioned in the paper.
GET /repositories/List all repositories.Return a paginated listing of all repositories.
GET /repositories/{owner}/List all repositories for a specific repo owner.Return a paginated listing of all repositories with a specific owner.
GET /repositories/{owner}/{name}/Get a Repository.Return a specific repository selected by its owner/name.
GET /search/Search similar to the frontpage search.Search in a similar fashion to the frontpage search. Limited to only 200 results.
GET /tasks/List all Tasks.Return a paginated listing of all tasks.
GET /tasks/{task}/Get a Task.Return a selected task by its id.
GET /tasks/{task}/children/List all task children.Return a paginated listing of all child tasks for a selected task.
GET /tasks/{task}/evaluations/List all evaluation tables in a task.Return a listing of all SOTA (evaluation tables) in a task.
GET /tasks/{task}/papers/List all papers in a task.Return a paginated listing of all papers in a selected task.
Esquema API original
{
"openapi": "3.0.1",
"info": {
"title": "PapersWithCode API",
"description": "PapersWithCode API Documentation ans Schema.",
"version": "v1"
},
"servers": [
{
"url": "https://paperswithcode.com/api/v1"
}
],
"security": [
{
"Basic": []
}
],
"paths": {
"/areas/": {
"get": {
"tags": [
"areas"
],
"summary": "List all task Areas.",
"description": "Return a paginated listing of all task ares..",
"operationId": "areas_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter areas by part of the name.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Area"
}
}
}
}
}
}
}
}
}
},
"/areas/{area}/": {
"get": {
"tags": [
"areas"
],
"summary": "Get an Area.",
"description": "Return a selected area by its id.",
"operationId": "areas_read",
"parameters": [
{
"name": "area",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Area"
}
}
}
}
}
}
},
"/areas/{area}/tasks/": {
"get": {
"tags": [
"areas"
],
"summary": "List all task in a an area.",
"description": "Return a paginated listing of task in a selected area.",
"operationId": "areas_tasks_list",
"parameters": [
{
"name": "area",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
}
}
}
}
},
"/authors/": {
"get": {
"tags": [
"authors"
],
"summary": "List all paper authors.",
"description": "Return a paginated list of paper authors.",
"operationId": "authors_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "full_name",
"in": "query",
"description": "Filter authors by part of their full name.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Author"
}
}
}
}
}
}
}
}
}
},
"/authors/{author}/papers/": {
"get": {
"tags": [
"authors"
],
"summary": "List all papers connected to the author.",
"description": "Return all papers connected to the author.",
"operationId": "authors_papers_list",
"parameters": [
{
"name": "author",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaperAuthorPaper"
}
}
}
}
}
}
}
}
}
},
"/datasets/": {
"get": {
"tags": [
"datasets"
],
"summary": "List all Datasets.",
"description": "Return a paginated listing of all datasets.",
"operationId": "datasets_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter datasets by their name.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "full_name",
"in": "query",
"description": "Filter datasets by their full name.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
}
}
}
}
}
}
}
}
}
},
"/datasets/{dataset}/": {
"get": {
"tags": [
"datasets"
],
"summary": "Get a Dataset.",
"description": "Return a specific dataset selected by its id.",
"operationId": "datasets_read",
"parameters": [
{
"name": "dataset",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dataset"
}
}
}
}
}
}
},
"/datasets/{dataset}/evaluations/": {
"get": {
"tags": [
"datasets"
],
"summary": "List all Evaluation Tables for a Dataset.",
"description": "Return a list of all SOTA (evaluation tables) for a selected dataset.",
"operationId": "datasets_evaluations_list",
"parameters": [
{
"name": "dataset",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EvaluationTable"
}
}
}
}
}
}
}
}
}
},
"/evaluations/": {
"get": {
"tags": [
"evaluations"
],
"summary": "List all Evaluation Tables.",
"description": "Return a paginated listing of all evaluation tables.",
"operationId": "evaluations_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EvaluationTable"
}
}
}
}
}
}
}
}
}
},
"/evaluations/{evaluation}/": {
"get": {
"tags": [
"evaluations"
],
"summary": "Get an evaluation table.",
"description": "Return a specific evaluation table selected by its id.",
"operationId": "evaluations_read",
"parameters": [
{
"name": "evaluation",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationTable"
}
}
}
}
}
}
},
"/evaluations/{evaluation}/metrics/": {
"get": {
"tags": [
"evaluations"
],
"summary": "Get evaluation table metric.",
"description": "Return a specific evaluation table metric.",
"operationId": "evaluations_metrics_list",
"parameters": [
{
"name": "evaluation",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Metric"
}
}
}
}
}
}
}
}
}
},
"/evaluations/{evaluation}/results/": {
"get": {
"tags": [
"evaluations"
],
"summary": "Get evaluation table results.",
"description": "Return a specific evaluation table results.",
"operationId": "evaluations_results_list",
"parameters": [
{
"name": "evaluation",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Result"
}
}
}
}
}
}
}
}
}
},
"/methods/": {
"get": {
"tags": [
"methods"
],
"summary": "List all Methods.",
"description": "Return a paginated listing of all methods.",
"operationId": "methods_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter methods by part of the name.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "full_name",
"in": "query",
"description": "Filter methods by part of the full name.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Method"
}
}
}
}
}
}
}
}
}
},
"/methods/{method}/": {
"get": {
"tags": [
"methods"
],
"summary": "Get a Method.",
"description": "Return a specific method selected by it's id.",
"operationId": "methods_read",
"parameters": [
{
"name": "method",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Method"
}
}
}
}
}
}
},
"/papers/": {
"get": {
"tags": [
"papers"
],
"summary": "List all Papers.",
"description": "Return a paginated listing of all papers.",
"operationId": "papers_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "arxiv_id",
"in": "query",
"description": "Filter papers by arxiv id.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "title",
"in": "query",
"description": "Filter papers by part of the title.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "abstract",
"in": "query",
"description": "Filter papers by part of the abstract.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Paper"
}
}
}
}
}
}
}
}
}
},
"/papers/{paper}/": {
"get": {
"tags": [
"papers"
],
"summary": "Get a Paper.",
"description": "Return a specific papers selected by its id.",
"operationId": "papers_read",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Paper"
}
}
}
}
}
}
},
"/papers/{paper}/datasets/": {
"get": {
"tags": [
"papers"
],
"summary": "List all datasets mentioned in the paper.",
"description": "Return all datasets mentioned in the paper.",
"operationId": "papers_datasets_list",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
}
}
}
}
}
}
}
}
}
},
"/papers/{paper}/methods/": {
"get": {
"tags": [
"papers"
],
"summary": "List all methods discussed in the paper.",
"description": "Return all methods mentioned in the paper.",
"operationId": "papers_methods_list",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Method"
}
}
}
}
}
}
}
}
}
},
"/papers/{paper}/repositories/": {
"get": {
"tags": [
"papers"
],
"summary": "List all repositories that implement a paper.",
"description": "Return all implementations of a selected paper.",
"operationId": "papers_repositories_list",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PgrRepo"
}
}
}
}
}
}
}
}
}
},
"/papers/{paper}/results/": {
"get": {
"tags": [
"papers"
],
"summary": "List all evaluation results for the paper.",
"description": "Return all evaluation results for the paper.",
"operationId": "papers_results_list",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Result"
}
}
}
}
}
}
}
}
}
},
"/papers/{paper}/tasks/": {
"get": {
"tags": [
"papers"
],
"summary": "List all tasks discussed in the paper.",
"description": "Return all tasks mentioned in the paper.",
"operationId": "papers_tasks_list",
"parameters": [
{
"name": "paper",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
}
}
}
}
},
"/repositories/": {
"get": {
"tags": [
"repositories"
],
"summary": "List all repositories.",
"description": "Return a paginated listing of all repositories.",
"operationId": "repositories_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "owner",
"in": "query",
"description": "Filter repositories by owner.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter repositories by name.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "stars",
"in": "query",
"description": "Filter repositories by minimum number of stars.",
"schema": {
"type": "integer"
}
},
{
"name": "framework",
"in": "query",
"description": "Filter repositories by framework",
"schema": {
"type": "string",
"enum": [
"none",
"tf",
"pytorch",
"mxnet",
"torch",
"caffe2",
"jax",
"paddle",
"mindspore"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Repository"
}
}
}
}
}
}
}
}
}
},
"/repositories/{owner}/": {
"get": {
"tags": [
"repositories"
],
"summary": "List all repositories for a specific repo owner.",
"description": "Return a paginated listing of all repositories with a specific owner.",
"operationId": "repositories_read",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter repositories by name.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "stars",
"in": "query",
"description": "Filter repositories by minimum number of stars.",
"schema": {
"type": "integer"
}
},
{
"name": "framework",
"in": "query",
"description": "Filter repositories by framework",
"schema": {
"type": "string",
"enum": [
"none",
"tf",
"pytorch",
"mxnet",
"torch",
"caffe2",
"jax",
"paddle",
"mindspore"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Repository"
}
}
}
}
}
}
}
}
}
},
"/repositories/{owner}/{name}/": {
"get": {
"tags": [
"repositories"
],
"summary": "Get a Repository.",
"description": "Return a specific repository selected by its owner/name.",
"operationId": "repositories_read",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Repository"
}
}
}
}
}
}
},
"/search/": {
"get": {
"tags": [
"search"
],
"summary": "Search similar to the frontpage search.",
"description": "Search in a similar fashion to the frontpage search.\n\nLimited to only 200 results.",
"operationId": "search_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search query.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaperRepo"
}
}
}
}
}
}
}
}
}
},
"/tasks/": {
"get": {
"tags": [
"tasks"
],
"summary": "List all Tasks.",
"description": "Return a paginated listing of all tasks.",
"operationId": "tasks_list",
"parameters": [
{
"name": "ordering",
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"description": "Search all searchable fields.",
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter tasks by part of th name.",
"schema": {
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
}
}
}
}
},
"/tasks/{task}/": {
"get": {
"tags": [
"tasks"
],
"summary": "Get a Task.",
"description": "Return a selected task by its id.",
"operationId": "tasks_read",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
}
},
"/tasks/{task}/children/": {
"get": {
"tags": [
"tasks"
],
"summary": "List all task children.",
"description": "Return a paginated listing of all child tasks for a selected task.",
"operationId": "tasks_children_list",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
}
}
}
}
},
"/tasks/{task}/evaluations/": {
"get": {
"tags": [
"tasks"
],
"summary": "List all evaluation tables in a task.",
"description": "Return a listing of all SOTA (evaluation tables) in a task.",
"operationId": "tasks_evaluations_list",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EvaluationTable"
}
}
}
}
}
}
}
}
}
},
"/tasks/{task}/papers/": {
"get": {
"tags": [
"tasks"
],
"summary": "List all papers in a task.",
"description": "Return a paginated listing of all papers in a selected task.",
"operationId": "tasks_papers_list",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "items_per_page",
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"count",
"results"
],
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"next": {
"type": "string",
"format": "uri",
"nullable": true
},
"previous": {
"type": "string",
"format": "uri",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Paper"
}
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Area": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 512,
"minLength": 1,
"type": "string"
}
}
},
"Task": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"maxLength": 10000,
"minLength": 1,
"type": "string",
"nullable": true
}
}
},
"Author": {
"required": [
"full_name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"full_name": {
"title": "Full name",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
}
},
"PaperAuthorPaper": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"arxiv_id": {
"title": "Arxiv id",
"type": "string",
"readOnly": true
},
"nips_id": {
"title": "Nips id",
"type": "string",
"readOnly": true
},
"url_abs": {
"title": "Url abs",
"type": "string",
"readOnly": true
},
"url_pdf": {
"title": "Url pdf",
"type": "string",
"readOnly": true
},
"title": {
"title": "Title",
"type": "string",
"readOnly": true
},
"abstract": {
"title": "Abstract",
"type": "string",
"readOnly": true
},
"authors": {
"title": "Authors",
"type": "string",
"readOnly": true
},
"published": {
"title": "Published",
"type": "string",
"readOnly": true
},
"conference": {
"title": "Conference",
"type": "string",
"readOnly": true
},
"conference_url_abs": {
"title": "Conference url abs",
"type": "string",
"readOnly": true
},
"conference_url_pdf": {
"title": "Conference url pdf",
"type": "string",
"readOnly": true
},
"proceeding": {
"title": "Proceeding",
"type": "string",
"readOnly": true
}
}
},
"Conference": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
}
},
"Proceeding": {
"required": [
"year"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"year": {
"title": "Year",
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"month": {
"title": "Month",
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"nullable": true
}
}
},
"Paper": {
"required": [
"url_abs"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"arxiv_id": {
"title": "Arxiv id",
"maxLength": 100,
"type": "string",
"nullable": true
},
"nips_id": {
"title": "Nips id",
"maxLength": 1000,
"type": "string",
"nullable": true
},
"url_abs": {
"title": "Url abs",
"maxLength": 1000,
"minLength": 1,
"type": "string",
"format": "uri"
},
"url_pdf": {
"title": "Url pdf",
"maxLength": 1000,
"minLength": 1,
"type": "string",
"format": "uri",
"nullable": true
},
"title": {
"title": "Title",
"maxLength": 1024,
"minLength": 1,
"type": "string",
"nullable": true
},
"abstract": {
"title": "Abstract",
"minLength": 1,
"type": "string",
"nullable": true
},
"authors": {
"title": "Authors",
"type": "string",
"readOnly": true
},
"published": {
"title": "Published",
"type": "string",
"format": "date",
"nullable": true
},
"conference": {
"title": "Conference",
"type": "string",
"readOnly": true
},
"conference_url_abs": {
"title": "Conference url abs",
"maxLength": 200,
"minLength": 1,
"type": "string",
"format": "uri",
"nullable": true
},
"conference_url_pdf": {
"title": "Conference url pdf",
"maxLength": 200,
"minLength": 1,
"type": "string",
"format": "uri",
"nullable": true
},
"proceeding": {
"title": "Proceeding",
"type": "string",
"readOnly": true
}
}
},
"Dataset": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"full_name": {
"title": "Full name",
"maxLength": 128,
"minLength": 1,
"type": "string",
"nullable": true
},
"url": {
"title": "Url",
"maxLength": 200,
"minLength": 1,
"type": "string",
"format": "uri",
"nullable": true
}
}
},
"DatasetCreate": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string"
},
"full_name": {
"title": "Full name",
"minLength": 1,
"type": "string",
"nullable": true
},
"url": {
"title": "Url",
"minLength": 1,
"type": "string",
"nullable": true
}
}
},
"DatasetUpdate": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string",
"nullable": true
},
"full_name": {
"title": "Full name",
"minLength": 1,
"type": "string",
"nullable": true
},
"url": {
"title": "Url",
"minLength": 1,
"type": "string",
"nullable": true
}
}
},
"EvaluationTable": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"task": {
"title": "Task",
"type": "string",
"readOnly": true
},
"dataset": {
"title": "Dataset",
"type": "string",
"readOnly": true
},
"description": {
"title": "Description",
"type": "string"
},
"mirror_url": {
"title": "Mirror url",
"maxLength": 200,
"type": "string",
"format": "uri",
"nullable": true
}
}
},
"EvaluationTableCreate": {
"required": [
"dataset",
"task"
],
"type": "object",
"properties": {
"task": {
"title": "Task",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug"
},
"dataset": {
"title": "Dataset",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug"
},
"description": {
"title": "Description",
"type": "string"
},
"mirror_url": {
"title": "Mirror url",
"maxLength": 200,
"type": "string",
"format": "uri",
"nullable": true
}
}
},
"EvaluationTableUpdate": {
"type": "object",
"properties": {
"task": {
"title": "Task",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug",
"nullable": true
},
"dataset": {
"title": "Dataset",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug",
"nullable": true
},
"description": {
"title": "Description",
"type": "string"
},
"mirror_url": {
"title": "Mirror url",
"maxLength": 200,
"type": "string",
"format": "uri",
"nullable": true
}
}
},
"Metric": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"is_loss": {
"title": "Is loss",
"type": "boolean"
}
}
},
"MetricCreate": {
"required": [
"is_loss",
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"type": "string",
"nullable": true,
"default": ""
},
"is_loss": {
"title": "Is loss",
"type": "boolean"
}
}
},
"MetricUpdate": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"nullable": true
},
"description": {
"title": "Description",
"type": "string",
"nullable": true
},
"is_loss": {
"title": "Is loss",
"type": "boolean",
"nullable": true
}
}
},
"Result": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"best_rank": {
"title": "Best rank",
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"nullable": true
},
"metrics": {
"title": "Metrics",
"type": "string",
"readOnly": true
},
"methodology": {
"title": "Methodology",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"uses_additional_data": {
"title": "Uses additional data",
"type": "boolean"
},
"paper": {
"title": "Paper",
"type": "string",
"readOnly": true
},
"best_metric": {
"title": "Best metric",
"type": "string",
"readOnly": true
},
"evaluated_on": {
"title": "Evaluated on",
"type": "string",
"readOnly": true
},
"evaluation": {
"title": "Evaluation",
"type": "string",
"readOnly": true
}
}
},
"ResultCreate": {
"required": [
"methodology",
"metrics"
],
"type": "object",
"properties": {
"metrics": {
"title": "Metrics",
"type": "object",
"additionalProperties": {
"minLength": 1,
"type": "string"
}
},
"methodology": {
"title": "Methodology",
"minLength": 1,
"type": "string"
},
"uses_additional_data": {
"title": "Uses additional data",
"type": "boolean",
"default": false
},
"paper": {
"title": "Paper",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug"
},
"evaluated_on": {
"title": "Evaluated on",
"type": "string",
"format": "date",
"nullable": true
}
}
},
"ResultUpdate": {
"type": "object",
"properties": {
"metrics": {
"title": "Metrics",
"type": "object",
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"nullable": true
},
"methodology": {
"title": "Methodology",
"minLength": 1,
"type": "string",
"nullable": true
},
"uses_additional_data": {
"title": "Uses additional data",
"type": "boolean",
"nullable": true,
"default": false
},
"paper": {
"title": "Paper",
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string",
"format": "slug",
"nullable": true
},
"evaluated_on": {
"title": "Evaluated on",
"type": "string",
"format": "date",
"nullable": true
}
}
},
"Method": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"full_name": {
"title": "Full name",
"maxLength": 512,
"minLength": 1,
"type": "string",
"nullable": true
},
"description": {
"title": "Description",
"maxLength": 10000,
"minLength": 1,
"type": "string",
"nullable": true
},
"paper": {
"title": "Paper",
"type": "string",
"readOnly": true
}
}
},
"PgrRepo": {
"type": "object",
"properties": {
"url": {
"title": "Url",
"type": "string",
"readOnly": true
},
"owner": {
"title": "Owner",
"type": "string",
"readOnly": true
},
"name": {
"title": "Name",
"type": "string",
"readOnly": true
},
"description": {
"title": "Description",
"type": "string",
"readOnly": true
},
"stars": {
"title": "Stars",
"type": "string",
"readOnly": true
},
"framework": {
"title": "Framework",
"type": "string",
"readOnly": true
},
"is_official": {
"title": "Is official",
"type": "boolean"
}
}
},
"Repository": {
"required": [
"name",
"owner",
"url"
],
"type": "object",
"properties": {
"url": {
"title": "Url",
"maxLength": 200,
"minLength": 1,
"type": "string",
"format": "uri"
},
"owner": {
"title": "Owner",
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"name": {
"title": "Name",
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"stars": {
"title": "Stars",
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"framework": {
"title": "Framework",
"type": "string",
"enum": [
"none",
"tf",
"pytorch",
"mxnet",
"torch",
"caffe2",
"jax",
"paddle",
"mindspore"
]
}
}
},
"PgrPaper": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true
},
"arxiv_id": {
"title": "Arxiv id",
"type": "string",
"readOnly": true
},
"nips_id": {
"title": "Nips id",
"type": "string",
"readOnly": true
},
"url_abs": {
"title": "Url abs",
"type": "string",
"readOnly": true
},
"url_pdf": {
"title": "Url pdf",
"type": "string",
"readOnly": true
},
"title": {
"title": "Title",
"type": "string",
"readOnly": true
},
"abstract": {
"title": "Abstract",
"type": "string",
"readOnly": true
},
"authors": {
"title": "Authors",
"type": "string",
"readOnly": true
},
"published": {
"title": "Published",
"type": "string",
"readOnly": true
},
"conference": {
"title": "Conference",
"type": "string",
"readOnly": true
},
"conference_url_abs": {
"title": "Conference url abs",
"type": "string",
"readOnly": true
},
"conference_url_pdf": {
"title": "Conference url pdf",
"type": "string",
"readOnly": true
},
"proceeding": {
"title": "Proceeding",
"type": "string",
"readOnly": true
},
"is_official": {
"title": "Is official",
"type": "boolean"
}
}
},
"MetricSynchronize": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"type": "string",
"default": ""
},
"is_loss": {
"title": "Is loss",
"type": "boolean",
"default": true
}
}
},
"ResultSynchronize": {
"required": [
"methodology",
"metrics"
],
"type": "object",
"properties": {
"metrics": {
"title": "Metrics",
"type": "object",
"additionalProperties": {
"minLength": 1,
"type": "string"
}
},
"methodology": {
"title": "Methodology",
"minLength": 1,
"type": "string"
},
"uses_additional_data": {
"title": "Uses additional data",
"type": "boolean",
"default": false
},
"paper": {
"title": "Paper",
"type": "string",
"nullable": true
},
"external_id": {
"title": "External id",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"evaluated_on": {
"title": "Evaluated on",
"type": "string",
"format": "date",
"nullable": true
},
"external_source_url": {
"title": "External source url",
"type": "string",
"format": "uri",
"nullable": true
}
}
},
"EvaluationSynchronize": {
"required": [
"dataset",
"metrics",
"results",
"task"
],
"type": "object",
"properties": {
"task": {
"title": "Task",
"minLength": 1,
"type": "string"
},
"dataset": {
"title": "Dataset",
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"type": "string",
"default": ""
},
"mirror_url": {
"title": "Mirror url",
"minLength": 1,
"type": "string",
"format": "uri",
"nullable": true
},
"external_id": {
"title": "External id",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricSynchronize"
}
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResultSynchronize"
}
}
}
},
"PaperRepo": {
"required": [
"paper",
"repository"
],
"type": "object",
"properties": {
"paper": {
"$ref": "#/components/schemas/Paper"
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"is_official": {
"title": "Is official",
"type": "boolean"
}
}
},
"TaskCreate": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string"
},
"description": {
"title": "Description",
"type": "string",
"nullable": true,
"default": ""
},
"area": {
"title": "Area",
"minLength": 1,
"type": "string",
"nullable": true
},
"parent_task": {
"title": "Parent task",
"type": "string",
"nullable": true
}
}
},
"TaskUpdate": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"minLength": 1,
"type": "string",
"nullable": true
},
"description": {
"title": "Description",
"minLength": 1,
"type": "string",
"nullable": true
},
"area": {
"title": "Area",
"minLength": 1,
"type": "string",
"nullable": true
},
"parent_task": {
"title": "Parent task",
"type": "string",
"nullable": true
}
}
}
},
"securitySchemes": {
"Basic": {
"type": "http",
"scheme": "basic"
}
}
},
"x-original-swagger-version": "2.0"
}Link Reader
A plugin that allows users to input any url, gets content from it, including webpage, youtube, PDF, PPT, image, word, pages, numbers, excels, google drive etc. It searches up-to-date info in google.
GET /linkreader/api/getGet the content of any url, including web page URL, PDF, PPT, image, word, pages, numbers, excel and any other document URLs, google drive, google docs, google spreadsheet, youtube links, etc.GET /linkreader/api/searchSearch Google and fetch JSON data
Esquema API original
{
"openapi": "3.0.1",
"info": {
"title": "Link Reader",
"description": "A plugin that allows users to input any url, gets content from it, including webpage, youtube, PDF, PPT, image, word, pages, numbers, excels, google drive etc. It searches up-to-date info in google.",
"version": "v1"
},
"servers": [
{
"url": "https://gochitchat.ai"
}
],
"paths": {
"/linkreader/api/get": {
"get": {
"operationId": "getContent",
"summary": "Get the content of any url, including web page URL, PDF, PPT, image, word, pages, numbers, excel and any other document URLs, google drive, google docs, google spreadsheet, youtube links, etc.",
"parameters": [
{
"name": "url",
"in": "query",
"description": "The url to get the content from",
"required": true,
"schema": {
"type": "string",
"format": "uri"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getContentResponse"
}
}
}
}
}
}
},
"/linkreader/api/search": {
"get": {
"operationId": "apiSearch",
"summary": "Search Google and fetch JSON data",
"parameters": [
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": "The query you want to search."
},
{
"name": "gl",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The country to use for the Google search (e.g., us for the United States, uk for United Kingdom, or fr for France)."
},
{
"name": "hl",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The language to use for the Google search. It's a two-letter language code. (e.g., en for English, es for Spanish, or fr for French)."
},
{
"name": "tbm",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The type of search you want to do (e.g. using \"isch\" retrieves images, \"nws\" retrieves news)."
},
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The result offset. It skips the given number of results. It's used for pagination."
},
{
"name": "num",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The maximum number of results to return. (e.g., 10 (default) returns 10 results)."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apiSearchResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"getContentResponse": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content of the url"
},
"statusCode": {
"type": "integer",
"description": "The status code of the request"
},
"statusText": {
"type": "string",
"description": "The status text of the request"
},
"headers": {
"type": "object",
"properties": {
"content-type": {
"type": "string",
"description": "The content type of the request"
},
"content-length": {
"type": "integer",
"description": "The content length of the request"
},
"date": {
"type": "string",
"description": "The date of the request"
},
"server": {
"type": "string",
"description": "The server of the request"
},
"last-modified": {
"type": "string",
"description": "The last modified date of the request"
}
}
},
"meta": {
"type": "object",
"properties": {
"og:title": {
"type": "string",
"description": "The title of the url"
},
"og:description": {
"type": "string",
"description": "The description of the url"
},
"og:image": {
"type": "string",
"description": "The main image of the url"
},
"og:type": {
"type": "string",
"description": "The type of the url"
}
}
}
}
},
"apiSearchResponse": {
"type": "object",
"properties": {
"answer_box": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the answer box"
},
"link": {
"type": "string",
"description": "The link of the answer box"
},
"snippet": {
"type": "string",
"description": "The snippet of the answer box"
},
"images": {
"type": "array",
"items": {
"type": "string",
"description": "The image links of the answer box"
}
}
}
},
"knowledge_graph": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the knowledge graph"
},
"type": {
"type": "string",
"description": "The type of entity in the knowledge graph"
},
"kgmid": {
"type": "string",
"description": "The unique identifier of the entity in the knowledge graph"
},
"description": {
"type": "string",
"description": "The description of the entity in the knowledge graph"
},
"source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the source"
},
"link": {
"type": "string",
"description": "The link to the source"
}
}
},
"images": {
"type": "array",
"items": {
"type": "string",
"description": "The image links of the knowledge graph entity"
}
}
}
},
"organic_results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the organic result"
},
"link": {
"type": "string",
"description": "The link to the organic result"
},
"snippet": {
"type": "string",
"description": "The snippet of the organic result"
},
"source": {
"type": "string",
"description": "The source of the organic result"
},
"images": {
"type": "array",
"items": {
"type": "string",
"description": "The image links of the organic result"
}
}
}
}
},
"video_results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the video result"
},
"link": {
"type": "string",
"description": "The link to the video result"
},
"snippet": {
"type": "string",
"description": "The snippet of the video result"
},
"thumbnail": {
"type": "string",
"description": "The link to the thumbnail of the video result"
},
"source": {
"type": "string",
"description": "The source of the video result"
}
}
}
},
"news_results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the news result"
},
"link": {
"type": "string",
"description": "The link to the news result"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The publication date of the news result"
},
"snippet": {
"type": "string",
"description": "The snippet of the news result"
},
"category": {
"type": "string",
"description": "The category of the news result"
},
"thumbnail": {
"type": "string",
"description": "The link to the thumbnail of the news result"
},
"source": {
"type": "string",
"description": "The source of the news result"
}
}
}
},
"images_results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the image result"
},
"original": {
"type": "string",
"description": "The original source url of the image"
},
"link": {
"type": "string",
"description": "The link to the result page"
}
}
}
},
"pagination": {
"type": "object",
"properties": {
"current": {
"type": "integer",
"description": "The current page number"
},
"next": {
"type": "string",
"description": "The query parameters for the next page"
}
}
}
}
}
}
}
}