neurosynth_compose_sdk.PostApi

All URIs are relative to https://compose.neurosynth.org/api

Method	HTTP request	Description
annotations_post	POST /annotations	Create a new Annotation
meta_analyses_post	POST /meta-analyses	Create a new meta-analysis
meta_analysis_results_post	POST /meta-analysis-results
neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post	POST /meta-analysis-jobs	Submit a meta-analysis job
projects_post	POST /projects
specifications_post	POST /specifications	Create a Specification
studysets_post	POST /studysets	Create a new Studyset
tags_post	POST /tags	Create a new Tag

annotations_post

AnnotationReturn annotations_post(annotation_post_body=annotation_post_body)

Create a new Annotation

create a new serialized/referenced annotation

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.annotation_post_body import AnnotationPostBody
from neurosynth_compose_sdk.models.annotation_return import AnnotationReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    annotation_post_body = neurosynth_compose_sdk.AnnotationPostBody() # AnnotationPostBody |  (optional)

    try:
        # Create a new Annotation
        api_response = api_instance.annotations_post(annotation_post_body=annotation_post_body)
        print("The response of PostApi->annotations_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->annotations_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
annotation_post_body	AnnotationPostBody		[optional]

Return type

AnnotationReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	form when a request goes wrong	-
422	form when a request goes wrong	-
500	form when a request goes wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

meta_analyses_post

MetaAnalysisReturn meta_analyses_post(meta_analysis_post_body=meta_analysis_post_body)

Create a new meta-analysis

create a new specification, studyset, annotation bundle

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.meta_analysis_post_body import MetaAnalysisPostBody
from neurosynth_compose_sdk.models.meta_analysis_return import MetaAnalysisReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    meta_analysis_post_body = neurosynth_compose_sdk.MetaAnalysisPostBody() # MetaAnalysisPostBody |  (optional)

    try:
        # Create a new meta-analysis
        api_response = api_instance.meta_analyses_post(meta_analysis_post_body=meta_analysis_post_body)
        print("The response of PostApi->meta_analyses_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->meta_analyses_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
meta_analysis_post_body	MetaAnalysisPostBody		[optional]

Return type

MetaAnalysisReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	form when a request goes wrong	-
422	form when a request goes wrong	-
500	form when a request goes wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

meta_analysis_results_post

ResultReturn meta_analysis_results_post(result_init=result_init)

Example

Bearer Authentication (JSON-Web-Token):
Api Key Authentication (upload_key):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.result_init import ResultInit
from neurosynth_compose_sdk.models.result_return import ResultReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: upload_key
configuration.api_key['upload_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['upload_key'] = 'Bearer'

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    result_init = neurosynth_compose_sdk.ResultInit() # ResultInit |  (optional)

    try:
        # 
        api_response = api_instance.meta_analysis_results_post(result_init=result_init)
        print("The response of PostApi->meta_analysis_results_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->meta_analysis_results_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_init	ResultInit		[optional]

Return type

ResultReturn

Authorization

JSON-Web-Token, upload_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post

MetaAnalysisJobResponse neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post(meta_analysis_job_request)

Submit a meta-analysis job

Submit a meta-analysis to the compose runner service.

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.meta_analysis_job_request import MetaAnalysisJobRequest
from neurosynth_compose_sdk.models.meta_analysis_job_response import MetaAnalysisJobResponse
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    meta_analysis_job_request = neurosynth_compose_sdk.MetaAnalysisJobRequest() # MetaAnalysisJobRequest | 

    try:
        # Submit a meta-analysis job
        api_response = api_instance.neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post(meta_analysis_job_request)
        print("The response of PostApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
meta_analysis_job_request	MetaAnalysisJobRequest

Return type

MetaAnalysisJobResponse

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
202	Job accepted	-
401	form when a request goes wrong	-
403	form when a request goes wrong	-
422	form when a request goes wrong	-
502	form when a request goes wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

projects_post

ProjectReturn projects_post(source_id=source_id, copy_annotations=copy_annotations, project=project)

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.project import Project
from neurosynth_compose_sdk.models.project_return import ProjectReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    source_id = 'source_id_example' # str | clone an existing project when creating a new project (optional)
    copy_annotations = True # bool | when cloning via `source_id`, also duplicate associated annotations (optional)
    project = neurosynth_compose_sdk.Project() # Project |  (optional)

    try:
        # 
        api_response = api_instance.projects_post(source_id=source_id, copy_annotations=copy_annotations, project=project)
        print("The response of PostApi->projects_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->projects_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
source_id	str	clone an existing project when creating a new project	[optional]
copy_annotations	bool	when cloning via `source_id`, also duplicate associated annotations	[optional]
project	Project		[optional]

Return type

ProjectReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

specifications_post

SpecificationReturn specifications_post(specification_post_body=specification_post_body)

Create a Specification

create a new meta-analysis specification

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody
from neurosynth_compose_sdk.models.specification_return import SpecificationReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    specification_post_body = neurosynth_compose_sdk.SpecificationPostBody() # SpecificationPostBody |  (optional)

    try:
        # Create a Specification
        api_response = api_instance.specifications_post(specification_post_body=specification_post_body)
        print("The response of PostApi->specifications_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->specifications_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
specification_post_body	SpecificationPostBody		[optional]

Return type

SpecificationReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	form when a request goes wrong	-
422	Unprocessable Entity (WebDAV)	-
500	form when a request goes wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

studysets_post

StudysetReturn studysets_post(studyset_post_body=studyset_post_body)

Create a new Studyset

create a new serialized/referenced studyset

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.studyset_post_body import StudysetPostBody
from neurosynth_compose_sdk.models.studyset_return import StudysetReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    studyset_post_body = neurosynth_compose_sdk.StudysetPostBody() # StudysetPostBody |  (optional)

    try:
        # Create a new Studyset
        api_response = api_instance.studysets_post(studyset_post_body=studyset_post_body)
        print("The response of PostApi->studysets_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->studysets_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
studyset_post_body	StudysetPostBody		[optional]

Return type

StudysetReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	form when a request goes wrong	-
422	form when a request goes wrong	-
500	form when a request goes wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tags_post

TagReturn tags_post(tag=tag)

Create a new Tag

Example

Bearer Authentication (JSON-Web-Token):

import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.tag import Tag
from neurosynth_compose_sdk.models.tag_return import TagReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.PostApi(api_client)
    tag = neurosynth_compose_sdk.Tag() # Tag |  (optional)

    try:
        # Create a new Tag
        api_response = api_instance.tags_post(tag=tag)
        print("The response of PostApi->tags_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->tags_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag	Tag		[optional]

Return type

TagReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

PostApi.md

Latest commit

History

PostApi.md

File metadata and controls

neurosynth_compose_sdk.PostApi

annotations_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analyses_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analysis_results_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

projects_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

specifications_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

studysets_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

tags_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details