neurosynth_compose_sdk.MetaAnalysesApi

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

Method	HTTP request	Description
meta_analyses_get	GET /meta-analyses	GET a list of meta-analyses
meta_analyses_id_get	GET /meta-analyses/{id}	GET meta-analysis information
meta_analyses_id_put	PUT /meta-analyses/{id}	Update a meta-analysis
meta_analyses_post	POST /meta-analyses	Create a new meta-analysis
meta_analysis_results_get	GET /meta-analysis-results	Your GET endpoint
meta_analysis_results_id_get	GET /meta-analysis-results/{id}	Your GET endpoint
meta_analysis_results_id_put	PUT /meta-analysis-results/{id}
meta_analysis_results_post	POST /meta-analysis-results

meta_analyses_get

MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)

GET a list of meta-analyses

list all runnable specification, studyset, annotation bundles

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.meta_analysis_list import MetaAnalysisList
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"
)


# 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.MetaAnalysesApi(api_client)
    nested = True # bool | show nested component instead of id (optional)
    ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
    page = 56 # int | page of results (optional)
    page_size = 56 # int | number of elements to return on a page (optional)
    name = 'name_example' # str | search the name field for a term (optional)
    search = 'imagin' # str | search for entries that contain the substring (optional)
    description = 'description_example' # str | search description field for a term (optional)
    sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
    desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)

    try:
        # GET a list of meta-analyses
        api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
        print("The response of MetaAnalysesApi->meta_analyses_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analyses_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
nested	bool	show nested component instead of id	[optional]
ids	List[str]	choose the specific ids you wish to get	[optional]
page	int	page of results	[optional]
page_size	int	number of elements to return on a page	[optional]
name	str	search the name field for a term	[optional]
search	str	search for entries that contain the substring	[optional]
description	str	search description field for a term	[optional]
sort	str	Parameter to sort results on	[optional] [default to 'created_at']
desc	bool	sort results by descending order (as opposed to ascending order)	[optional]

Return type

MetaAnalysisList

Authorization

No authorization required

HTTP request headers

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

HTTP response details

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

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

meta_analyses_id_get

MetaAnalysisReturn meta_analyses_id_get(id, nested=nested)

GET meta-analysis information

get a meta-analysis (specification, annotation, and studyset)

Example

import time
import os
import neurosynth_compose_sdk
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"
)


# 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.MetaAnalysesApi(api_client)
    id = 'id_example' # str | 
    nested = True # bool | show nested component instead of id (optional)

    try:
        # GET meta-analysis information
        api_response = api_instance.meta_analyses_id_get(id, nested=nested)
        print("The response of MetaAnalysesApi->meta_analyses_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analyses_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
nested	bool	show nested component instead of id	[optional]

Return type

MetaAnalysisReturn

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	form when a request goes wrong	-
404	form when a request goes wrong	-

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

meta_analyses_id_put

MetaAnalysisReturn meta_analyses_id_put(id, meta_analysis=meta_analysis)

Update a meta-analysis

update an existing meta-analysis (that has not yet been run)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.meta_analysis import MetaAnalysis
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.MetaAnalysesApi(api_client)
    id = 'id_example' # str | 
    meta_analysis = neurosynth_compose_sdk.MetaAnalysis() # MetaAnalysis |  (optional)

    try:
        # Update a meta-analysis
        api_response = api_instance.meta_analyses_id_put(id, meta_analysis=meta_analysis)
        print("The response of MetaAnalysesApi->meta_analyses_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analyses_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
meta_analysis	MetaAnalysis		[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	-
401	form when a request goes wrong	-
404	form when a request goes wrong	-
422	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 time
import os
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.MetaAnalysesApi(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 MetaAnalysesApi->meta_analyses_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->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_get

ResultList meta_analysis_results_get(meta_analysis_id=meta_analysis_id)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.result_list import ResultList
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"
)


# 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.MetaAnalysesApi(api_client)
    meta_analysis_id = 'meta_analysis_id_example' # str | search for results with this meta-analysis id (optional)

    try:
        # Your GET endpoint
        api_response = api_instance.meta_analysis_results_get(meta_analysis_id=meta_analysis_id)
        print("The response of MetaAnalysesApi->meta_analysis_results_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analysis_results_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
meta_analysis_id	str	search for results with this meta-analysis id	[optional]

Return type

ResultList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
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]

meta_analysis_results_id_get

ResultReturn meta_analysis_results_id_get(id)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
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"
)


# 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.MetaAnalysesApi(api_client)
    id = 'id_example' # str | 

    try:
        # Your GET endpoint
        api_response = api_instance.meta_analysis_results_id_get(id)
        print("The response of MetaAnalysesApi->meta_analysis_results_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analysis_results_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResultReturn

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
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]

meta_analysis_results_id_put

ResultReturn meta_analysis_results_id_put(id, result=result)

Example

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

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.result import Result
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.MetaAnalysesApi(api_client)
    id = 'id_example' # str | 
    result = neurosynth_compose_sdk.Result() # Result |  (optional)

    try:
        # 
        api_response = api_instance.meta_analysis_results_id_put(id, result=result)
        print("The response of MetaAnalysesApi->meta_analysis_results_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->meta_analysis_results_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
result	Result		[optional]

Return type

ResultReturn

Authorization

JSON-Web-Token, upload_key

HTTP request headers

Content-Type: application/json, multipart/form-data
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]

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 time
import os
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.MetaAnalysesApi(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 MetaAnalysesApi->meta_analysis_results_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetaAnalysesApi->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]

Files

MetaAnalysesApi.md

Latest commit

History

MetaAnalysesApi.md

File metadata and controls

neurosynth_compose_sdk.MetaAnalysesApi

meta_analyses_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analyses_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analyses_id_put

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_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analysis_results_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

meta_analysis_results_id_put

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